dbc6a6cc6c23118576e260b8d10d7603dc40f75d
[iotivity.git] / resource / csdk / connectivity / api / cacommon.h
1 /* ****************************************************************
2  *
3  * Copyright 2014 Samsung Electronics All Rights Reserved.
4  *
5  *
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  ******************************************************************/
20
21 /**
22  * @file cacommon.h
23  * This file contains the common data structures between Resource , CA and adapters
24  */
25
26 #ifndef CA_COMMON_H_
27 #define CA_COMMON_H_
28
29 #include "iotivity_config.h"
30
31 #include <limits.h>
32 #include <stdint.h>
33 #include <stdlib.h>
34 #include <stdbool.h>
35
36 #ifdef HAVE_SYS_POLL_H
37 #include <sys/poll.h>
38 #endif
39
40 #ifdef HAVE_WINSOCK2_H
41 #include <winsock2.h>
42 #include <mswsock.h>
43 #endif
44
45 #ifdef __cplusplus
46 extern "C"
47 {
48 #endif
49
50 /**
51  * TAG of Analyzer log.
52  */
53 #define ANALYZER_TAG "OIC_ANALYZER"
54
55 /**
56  * IP address Length.
57  */
58 #define CA_IPADDR_SIZE 16
59
60 /**
61  * Remote Access jabber ID length.
62  */
63 #define CA_RAJABBERID_SIZE 256
64
65 /**
66  * Mac address length for BT port.
67  */
68 #define CA_MACADDR_SIZE 18
69
70 /**
71  * Max header options data length.
72  */
73 #define CA_MAX_HEADER_OPTION_DATA_LENGTH 1024
74
75 /**
76 * Max token length.
77 */
78 #define CA_MAX_TOKEN_LEN (8)
79
80 /**
81  * Max URI length.
82  */
83 #define CA_MAX_URI_LENGTH 512 /* maximum size of URI */
84
85 /**
86  * Max PDU length supported.
87  */
88 #define COAP_MAX_PDU_SIZE           1400 /* maximum size of a CoAP PDU */
89
90 #ifdef WITH_BWT
91 #define CA_DEFAULT_BLOCK_SIZE       CA_BLOCK_SIZE_1024_BYTE
92 #endif
93
94 /**
95  *Maximum length of the remoteEndpoint identity.
96  */
97 #define CA_MAX_ENDPOINT_IDENTITY_LEN  CA_MAX_IDENTITY_SIZE
98
99 /**
100  * Max identity size.
101  */
102 #define CA_MAX_IDENTITY_SIZE (37)
103
104 /**
105  * option types - the highest option number 63.
106  */
107 #define CA_OPTION_IF_MATCH 1
108 #define CA_OPTION_ETAG 4
109 #define CA_OPTION_IF_NONE_MATCH 5
110 #define CA_OPTION_OBSERVE 6
111 #define CA_OPTION_LOCATION_PATH 8
112 #define CA_OPTION_URI_PATH 11
113 #define CA_OPTION_CONTENT_FORMAT 12
114 #define CA_OPTION_CONTENT_TYPE COAP_OPTION_CONTENT_FORMAT
115 #define CA_OPTION_MAXAGE 14
116 #define CA_OPTION_URI_QUERY 15
117 #define CA_OPTION_ACCEPT 17
118 #define CA_OPTION_LOCATION_QUERY 20
119
120 /**
121  * @def UUID_PREFIX
122  * @brief uuid prefix in certificate subject field
123  */
124 #define UUID_PREFIX "uuid:"
125
126 /**
127  * @def SUBJECT_PREFIX
128  * @brief prefix for specifying part of a cert's subject for a particular uuid
129  */
130 #define SUBJECT_PREFIX "CN=" UUID_PREFIX
131
132 /**
133 * TODO: Move these COAP defines to CoAP lib once approved.
134 */
135 #define COAP_MEDIATYPE_APPLICATION_VND_OCF_CBOR 10000 // application/vnd.ocf+cbor
136 #define CA_OPTION_ACCEPT_VERSION 2049
137 #define CA_OPTION_CONTENT_VERSION 2053
138
139 // The Accept Version and Content-Format Version for OCF 1.0.0 (0b0000 1000 0000 0000).
140 #define DEFAULT_VERSION_VALUE 2048
141
142 /**
143  * Payload information from resource model.
144  */
145 typedef uint8_t *CAPayload_t;
146
147 /**
148  * URI for the OIC base.CA considers relative URI as the URI.
149  */
150 typedef char *CAURI_t;
151
152 /**
153  * Token information for mapping the request and responses by resource model.
154  */
155 typedef char *CAToken_t;
156
157 /*
158  * Socket types and error definitions.
159  */
160 #ifdef HAVE_WINSOCK2_H
161 # define OC_SOCKET_ERROR      SOCKET_ERROR
162 # define OC_INVALID_SOCKET    INVALID_SOCKET
163 typedef SOCKET CASocketFd_t;
164 #else // HAVE_WINSOCK2_H
165 # define OC_SOCKET_ERROR      (-1)
166 # define OC_INVALID_SOCKET    (-1)
167 typedef int    CASocketFd_t;
168 #endif
169
170 /*
171  * The following flags are the same as the equivalent OIC values in
172  * octypes.h, allowing direct copying with slight fixup.
173  * The CA layer should used the OC types when build allows that.
174  */
175 #ifdef RA_ADAPTER
176 #define MAX_ADDR_STR_SIZE_CA (256)
177 #else
178 /*
179  * Max Address could be "coaps+tcp://[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:yyy.yyy.yyy.yyy]:xxxxx"
180  * Which is 65, +1 for null terminator => 66
181  * OCDevAddr (defined in OCTypes.h) must be the same
182  * as CAEndpoint_t (defined here)
183  */
184 #define MAX_ADDR_STR_SIZE_CA (66)
185 #endif
186
187 typedef enum
188 {
189     CA_DEFAULT_ADAPTER = 0,
190
191     // value zero indicates discovery
192     CA_ADAPTER_IP            = (1 << 0),   // IPv4 and IPv6, including 6LoWPAN
193     CA_ADAPTER_GATT_BTLE     = (1 << 1),   // GATT over Bluetooth LE
194     CA_ADAPTER_RFCOMM_BTEDR  = (1 << 2),   // RFCOMM over Bluetooth EDR
195
196 #ifdef RA_ADAPTER
197     CA_ADAPTER_REMOTE_ACCESS = (1 << 3),   // Remote Access over XMPP.
198 #endif
199
200     CA_ADAPTER_TCP           = (1 << 4),   // CoAP over TCP
201     CA_ADAPTER_NFC           = (1 << 5),   // NFC Adapter
202
203     CA_ALL_ADAPTERS          = 0xffffffff
204 } CATransportAdapter_t;
205
206 typedef enum
207 {
208     CA_DEFAULT_FLAGS = 0,
209
210     // Insecure transport is the default (subject to change)
211     CA_SECURE          = (1 << 4),   // secure the transport path
212     // IPv4 & IPv6 autoselection is the default
213     CA_IPV6            = (1 << 5),   // IP adapter only
214     CA_IPV4            = (1 << 6),   // IP adapter only
215     // Indication that a message was received by multicast.
216     CA_MULTICAST       = (1 << 7),
217     // Link-Local multicast is the default multicast scope for IPv6.
218     // These correspond in both value and position to the IPv6 address bits.
219     CA_SCOPE_INTERFACE = 0x1, // IPv6 Interface-Local scope
220     CA_SCOPE_LINK      = 0x2, // IPv6 Link-Local scope (default)
221     CA_SCOPE_REALM     = 0x3, // IPv6 Realm-Local scope
222     CA_SCOPE_ADMIN     = 0x4, // IPv6 Admin-Local scope
223     CA_SCOPE_SITE      = 0x5, // IPv6 Site-Local scope
224     CA_SCOPE_ORG       = 0x8, // IPv6 Organization-Local scope
225     CA_SCOPE_GLOBAL    = 0xE, // IPv6 Global scope
226 } CATransportFlags_t;
227
228 typedef enum
229 {
230     CA_DEFAULT_BT_FLAGS = 0,
231     // flags for BLE transport
232     CA_LE_ADV_DISABLE   = 0x1,   // disable BLE advertisement.
233     CA_LE_ADV_ENABLE    = 0x2,   // enable BLE advertisement.
234     CA_LE_SERVER_DISABLE = (1 << 4),   // disable gatt server.
235     // flags for EDR transport
236     CA_EDR_SERVER_DISABLE = (1 << 7)
237 } CATransportBTFlags_t;
238
239 #define CA_IPFAMILY_MASK (CA_IPV6|CA_IPV4)
240 #define CA_SCOPE_MASK 0xf     // mask scope bits above
241
242 /**
243  * Information about the network status.
244  */
245 typedef enum
246 {
247     CA_INTERFACE_DOWN,   /**< Connection is not available */
248     CA_INTERFACE_UP    /**< Connection is Available */
249 } CANetworkStatus_t;
250
251 /*
252  * remoteEndpoint identity.
253  */
254 typedef struct
255 {
256     uint16_t id_length;
257     unsigned char id[CA_MAX_ENDPOINT_IDENTITY_LEN];
258 } CARemoteId_t;
259
260 /**
261  * Message Type for Base source code.
262  */
263 typedef enum
264 {
265     CA_MSG_CONFIRM = 0,  /**< confirmable message (requires ACK/RST) */
266     CA_MSG_NONCONFIRM,   /**< non-confirmable message (one-shot message) */
267     CA_MSG_ACKNOWLEDGE,  /**< used to acknowledge confirmable messages */
268     CA_MSG_RESET         /**< used to indicates not-interested or error (lack of context)in
269                                                   received messages */
270 } CAMessageType_t;
271
272 /**
273  * Allowed method to be used by resource model.
274  */
275 typedef enum
276 {
277     CA_GET = 1, /**< GET Method  */
278     CA_POST,    /**< POST Method */
279     CA_PUT,     /**< PUT Method */
280     CA_DELETE   /**< DELETE Method */
281 } CAMethod_t;
282
283 /**
284  * block size.
285  * it depends on defined size in libCoAP.
286  */
287 typedef enum
288 {
289     CA_BLOCK_SIZE_16_BYTE = 0,    /**< 16byte */
290     CA_BLOCK_SIZE_32_BYTE = 1,    /**< 32byte */
291     CA_BLOCK_SIZE_64_BYTE = 2,    /**< 64byte */
292     CA_BLOCK_SIZE_128_BYTE = 3,   /**< 128byte */
293     CA_BLOCK_SIZE_256_BYTE = 4,   /**< 256byte */
294     CA_BLOCK_SIZE_512_BYTE = 5,   /**< 512byte */
295     CA_BLOCK_SIZE_1024_BYTE = 6     /**< 1Kbyte */
296 } CABlockSize_t;
297
298 /**
299  * Endpoint information for connectivities.
300  * Must be identical to OCDevAddr.
301  */
302 typedef struct
303 {
304     CATransportAdapter_t    adapter;    // adapter type
305     CATransportFlags_t      flags;      // transport modifiers
306     uint16_t                port;       // for IP
307     char                    addr[MAX_ADDR_STR_SIZE_CA]; // address for all
308     uint32_t                ifindex;    // usually zero for default interface
309     char                    remoteId[CA_MAX_IDENTITY_SIZE]; // device ID of remote device
310 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
311     char                    routeData[MAX_ADDR_STR_SIZE_CA]; /**< GatewayId:ClientId of
312                                                                     destination. **/
313 #endif
314 } CAEndpoint_t;
315
316 #define CA_SECURE_ENDPOINT_PUBLIC_KEY_MAX_LENGTH    (512)
317
318 /**
319  * Endpoint information for secure messages.
320  */
321 typedef struct
322 {
323     CAEndpoint_t endpoint;      /**< endpoint */
324     // TODO change name to deviceId
325     CARemoteId_t identity;      /**< endpoint device uuid */
326     CARemoteId_t userId;        /**< endpoint user uuid */
327     uint32_t attributes;
328     uint8_t publicKey[CA_SECURE_ENDPOINT_PUBLIC_KEY_MAX_LENGTH]; /**< Peer's DER-encoded public key (if using certificate) */
329     size_t publicKeyLength;     /**< Length of publicKey; zero if not using certificate */
330 } CASecureEndpoint_t;
331
332 /**
333  * Endpoint used for security administration - a special type of identity that
334  * bypasses Access Control Entry checks for SVR resources, while the device is
335  * not ready for normal operation yet.
336  */
337 #define CA_SECURE_ENDPOINT_ATTRIBUTE_ADMINISTRATOR  0x1
338
339 /**
340  * Enums for CA return values.
341  */
342 typedef enum
343 {
344     /* Result code - START HERE */
345     CA_STATUS_OK = 0,               /**< Success */
346     CA_STATUS_INVALID_PARAM,        /**< Invalid Parameter */
347     CA_ADAPTER_NOT_ENABLED,         /**< Adapter is not enabled */
348     CA_SERVER_STARTED_ALREADY,      /**< Server is started already */
349     CA_SERVER_NOT_STARTED,          /**< Server is not started */
350     CA_DESTINATION_NOT_REACHABLE,   /**< Destination is not reachable */
351     CA_SOCKET_OPERATION_FAILED,     /**< Socket operation failed */
352     CA_SEND_FAILED,                 /**< Send request failed */
353     CA_RECEIVE_FAILED,              /**< Receive failed */
354     CA_MEMORY_ALLOC_FAILED,         /**< Memory allocation failed */
355     CA_REQUEST_TIMEOUT,             /**< Request is Timeout */
356     CA_DESTINATION_DISCONNECTED,    /**< Destination is disconnected */
357     CA_NOT_SUPPORTED,               /**< Not supported */
358     CA_STATUS_NOT_INITIALIZED,      /**< Not Initialized*/
359     CA_DTLS_AUTHENTICATION_FAILURE, /**< Decryption error in DTLS */
360     CA_CONTINUE_OPERATION,          /**< Error happens but current operation should continue */
361     CA_HANDLE_ERROR_OTHER_MODULE,   /**< Error happens but it should be handled in other module */
362     CA_STATUS_FAILED =255           /**< Failure */
363     /* Result code - END HERE */
364 } CAResult_t;
365
366 /**
367  * Enums for CA Response values.
368  */
369 typedef enum
370 {
371     /* Response status code - START HERE */
372     CA_EMPTY = 0,                           /**< Empty */
373     CA_CREATED = 201,                       /**< Created */
374     CA_DELETED = 202,                       /**< Deleted */
375     CA_VALID = 203,                         /**< Valid */
376     CA_CHANGED = 204,                       /**< Changed */
377     CA_CONTENT = 205,                       /**< Content */
378     CA_CONTINUE = 231,                      /**< Continue */
379     CA_BAD_REQ = 400,                       /**< Bad Request */
380     CA_UNAUTHORIZED_REQ = 401,              /**< Unauthorized Request */
381     CA_BAD_OPT = 402,                       /**< Bad Option */
382     CA_FORBIDDEN_REQ = 403,                 /**< Forbidden Request */
383     CA_NOT_FOUND = 404,                     /**< Not found */
384     CA_METHOD_NOT_ALLOWED = 405,            /**< Method Not Allowed */
385     CA_NOT_ACCEPTABLE = 406,                /**< Not Acceptable */
386     CA_REQUEST_ENTITY_INCOMPLETE = 408,     /**< Request Entity Incomplete */
387     CA_REQUEST_ENTITY_TOO_LARGE = 413,      /**< Request Entity Too Large */
388     CA_INTERNAL_SERVER_ERROR = 500,         /**< Internal Server Error */
389     CA_BAD_GATEWAY = 502,
390     CA_SERVICE_UNAVAILABLE = 503,           /**< Server Unavailable */
391     CA_RETRANSMIT_TIMEOUT = 504,            /**< Retransmit timeout */
392     CA_PROXY_NOT_SUPPORTED = 505            /**< Proxy not enabled to service a request */
393     /* Response status code - END HERE */
394 } CAResponseResult_t;
395
396 /**
397  * Data type whether the data is Request Message or Response Message.
398  * if there is some failure before send data on network.
399  * Type will be set as error type for error callback.
400  */
401 typedef enum
402 {
403     CA_REQUEST_DATA = 1,
404     CA_RESPONSE_DATA,
405     CA_ERROR_DATA,
406     CA_RESPONSE_FOR_RES
407 } CADataType_t;
408
409 /**
410  * Transport Protocol IDs for additional options.
411  */
412 typedef enum
413 {
414     CA_INVALID_ID = (1 << 0),   /**< Invalid ID */
415     CA_COAP_ID = (1 << 1)       /**< COAP ID */
416 } CATransportProtocolID_t;
417
418 /**
419  * Adapter State to indicate the network changed notifications.
420  */
421 typedef enum
422 {
423     CA_ADAPTER_DISABLED,   /**< Adapter is Disabled */
424     CA_ADAPTER_ENABLED     /**< Adapter is Enabled */
425 } CAAdapterState_t;
426
427 /**
428  * Format indicating which encoding has been used on the payload.
429  */
430 typedef enum
431 {
432     CA_FORMAT_UNDEFINED = 0,            /**< Undefined enoding format */
433     CA_FORMAT_TEXT_PLAIN,
434     CA_FORMAT_APPLICATION_LINK_FORMAT,
435     CA_FORMAT_APPLICATION_XML,
436     CA_FORMAT_APPLICATION_OCTET_STREAM,
437     CA_FORMAT_APPLICATION_RDF_XML,
438     CA_FORMAT_APPLICATION_EXI,
439     CA_FORMAT_APPLICATION_JSON,
440     CA_FORMAT_APPLICATION_CBOR,
441     CA_FORMAT_APPLICATION_VND_OCF_CBOR,
442     CA_FORMAT_UNSUPPORTED
443 } CAPayloadFormat_t;
444
445 /**
446  * Option ID of header option. The values match CoAP option types in pdu.h.
447  */
448 typedef enum
449 {
450     CA_HEADER_OPTION_ID_LOCATION_PATH = 8,
451     CA_HEADER_OPTION_ID_LOCATION_QUERY = 20
452 } CAHeaderOptionId_t;
453
454 /**
455  * Header options structure to be filled.
456  *
457  * This structure is used to hold header information.
458  */
459 typedef struct
460 {
461     CATransportProtocolID_t protocolID;                     /**< Protocol ID of the Option */
462     uint16_t optionID;                                      /**< The header option ID which will be
463                                                             added to communication packets */
464     uint16_t optionLength;                                  /**< Option Length **/
465     char optionData[CA_MAX_HEADER_OPTION_DATA_LENGTH];      /**< Optional data values**/
466 } CAHeaderOption_t;
467
468 /**
469  * Base Information received.
470  *
471  * This structure is used to hold request & response base information.
472  */
473 typedef struct
474 {
475     CAMessageType_t type;       /**< Qos for the request */
476 #ifdef ROUTING_GATEWAY
477     bool skipRetransmission;    /**< Will not attempt retransmission even if type is CONFIRM.
478                                      Required for packet forwarding */
479 #endif
480     uint16_t messageId;         /**< Message id.
481                                  * if message id is zero, it will generated by CA inside.
482                                  * otherwise, you can use it */
483     CAToken_t token;            /**< Token for CA */
484     uint8_t tokenLength;        /**< token length */
485     CAHeaderOption_t *options;  /** Header Options for the request */
486     uint8_t numOptions;         /**< Number of Header options */
487     CAPayload_t payload;        /**< payload of the request  */
488     size_t payloadSize;         /**< size in bytes of the payload */
489     CAPayloadFormat_t payloadFormat;    /**< encoding format of the request payload */
490     CAPayloadFormat_t acceptFormat;     /**< accept format for the response payload */
491     uint16_t payloadVersion;    /**< version of the payload */
492     uint16_t acceptVersion;     /**< expected version for the response payload */
493     CAURI_t resourceUri;        /**< Resource URI information **/
494     CARemoteId_t identity;      /**< endpoint identity */
495     CADataType_t dataType;      /**< data type */
496 } CAInfo_t;
497
498 /**
499  * Request Information to be sent.
500  *
501  * This structure is used to hold request information.
502  */
503 typedef struct
504 {
505     CAMethod_t method;  /**< Name of the Method Allowed */
506     CAInfo_t info;      /**< Information of the request. */
507     bool isMulticast;   /**< is multicast request */
508 } CARequestInfo_t;
509
510 /**
511  * Response information received.
512  *
513  * This structure is used to hold response information.
514  */
515 typedef struct
516 {
517     CAResponseResult_t result;  /**< Result for response by resource model */
518     CAInfo_t info;              /**< Information of the response */
519     bool isMulticast;
520 } CAResponseInfo_t;
521
522 /**
523  * Error information from CA
524  *        contains error code and message information.
525  *
526  * This structure holds error information.
527  */
528 typedef struct
529 {
530     CAResult_t result;  /**< CA API request result  */
531     CAInfo_t info;      /**< message information such as token and payload data
532                              helpful to identify the error */
533 } CAErrorInfo_t;
534
535 /**
536  * Hold global variables for CA layer. (also used by RI layer)
537  */
538 typedef struct
539 {
540     CASocketFd_t fd;    /**< socket fd */
541     uint16_t port;      /**< socket port */
542 } CASocket_t;
543
544 #define HISTORYSIZE (4)
545
546 typedef struct
547 {
548     CATransportFlags_t flags;
549     uint16_t messageId;
550     char token[CA_MAX_TOKEN_LEN];
551     uint8_t tokenLength;
552     uint32_t ifindex;
553 } CAHistoryItem_t;
554
555 typedef struct
556 {
557     int nextIndex;
558     CAHistoryItem_t items[HISTORYSIZE];
559 } CAHistory_t;
560
561 /**
562  * Hold interface index for keeping track of comings and goings.
563  */
564 typedef struct
565 {
566     int32_t ifIndex; /**< network interface index */
567 } CAIfItem_t;
568
569 /**
570  * Hold the port number assigned from application.
571  * It will be used when creating a socket.
572  */
573 typedef struct
574 {
575     struct udpports
576     {
577         uint16_t u6;    /**< unicast IPv6 socket port */
578         uint16_t u6s;   /**< unicast IPv6 socket secure port */
579         uint16_t u4;    /**< unicast IPv4 socket port */
580         uint16_t u4s;   /**< unicast IPv4 socket secure port */
581     } udp;
582 #ifdef TCP_ADAPTER
583     struct tcpports
584     {
585         uint16_t u4;    /**< unicast IPv4 socket port */
586         uint16_t u4s;   /**< unicast IPv6 socket secure port */
587         uint16_t u6;    /**< unicast IPv6 socket port */
588         uint16_t u6s;   /**< unicast IPv6 socket secure port */
589     } tcp;
590 #endif
591 } CAPorts_t;
592
593 typedef struct
594 {
595     CATransportFlags_t clientFlags; /**< flag for client */
596     CATransportFlags_t serverFlags; /**< flag for server */
597     bool client; /**< client mode */
598     bool server; /**< server mode */
599
600     CAPorts_t ports;
601
602     struct sockets
603     {
604         void *threadpool;           /**< threadpool between Initialize and Start */
605         CASocket_t u6;              /**< unicast   IPv6 */
606         CASocket_t u6s;             /**< unicast   IPv6 secure */
607         CASocket_t u4;              /**< unicast   IPv4 */
608         CASocket_t u4s;             /**< unicast   IPv4 secure */
609         CASocket_t m6;              /**< multicast IPv6 */
610         CASocket_t m6s;             /**< multicast IPv6 secure */
611         CASocket_t m4;              /**< multicast IPv4 */
612         CASocket_t m4s;             /**< multicast IPv4 secure */
613 #if defined(_WIN32)
614         WSAEVENT addressChangeEvent;/**< Event used to signal address changes */
615         WSAEVENT shutdownEvent;     /**< Event used to signal threads to stop */
616 #else
617         int netlinkFd;              /**< netlink */
618         int shutdownFds[2];         /**< fds used to signal threads to stop */
619         CASocketFd_t maxfd;         /**< highest fd (for select) */
620 #endif
621         int selectTimeout;          /**< in seconds */
622         bool started;               /**< the IP adapter has started */
623         bool terminate;             /**< the IP adapter needs to stop */
624         bool ipv6enabled;           /**< IPv6 enabled by OCInit flags */
625         bool ipv4enabled;           /**< IPv4 enabled by OCInit flags */
626         bool dualstack;             /**< IPv6 and IPv4 enabled */
627 #if defined (_WIN32)
628         LPFN_WSARECVMSG wsaRecvMsg; /**< Win32 function pointer to WSARecvMsg() */
629 #endif
630
631         struct networkmonitors
632         {
633             CAIfItem_t *ifItems; /**< current network interface index list */
634             size_t sizeIfItems;  /**< size of network interface index array */
635             size_t numIfItems;   /**< number of valid network interfaces */
636         } nm;
637     } ip;
638
639     struct calayer
640     {
641         CAHistory_t requestHistory;  /**< filter IP family in requests */
642     } ca;
643
644 #ifdef TCP_ADAPTER
645     /**
646      * Hold global variables for TCP Adapter.
647      */
648     struct tcpsockets
649     {
650         void *threadpool;       /**< threadpool between Initialize and Start */
651         CASocket_t ipv4;        /**< IPv4 accept socket */
652         CASocket_t ipv4s;       /**< IPv4 accept socket secure */
653         CASocket_t ipv6;        /**< IPv6 accept socket */
654         CASocket_t ipv6s;       /**< IPv6 accept socket secure */
655         int selectTimeout;      /**< in seconds */
656         int listenBacklog;      /**< backlog counts*/
657 #if defined(_WIN32)
658         WSAEVENT updateEvent;   /**< Event used to signal thread to stop or update the FD list */
659 #else
660         int shutdownFds[2];     /**< shutdown pipe */
661         int connectionFds[2];   /**< connection pipe */
662         CASocketFd_t maxfd;     /**< highest fd (for select) */
663 #endif
664         bool started;           /**< the TCP adapter has started */
665         volatile bool terminate;/**< the TCP adapter needs to stop */
666         bool ipv4tcpenabled;    /**< IPv4 TCP enabled by OCInit flags */
667         bool ipv6tcpenabled;    /**< IPv6 TCP enabled by OCInit flags */
668     } tcp;
669 #endif
670     CATransportBTFlags_t bleFlags;   /**< flags related BLE transport */
671 } CAGlobals_t;
672
673 extern CAGlobals_t caglobals;
674
675 typedef enum
676 {
677     CA_LOG_LEVEL_ALL = 1,             // all logs.
678     CA_LOG_LEVEL_INFO,                // debug level is disabled.
679 } CAUtilLogLevel_t;
680
681 /**
682  * Callback function type for request delivery.
683  * @param[out]   object       Endpoint object from which the request is received.
684  *                            It contains endpoint address based on the connectivity type.
685  * @param[out]   requestInfo  Info for resource model to understand about the request.
686  */
687 typedef void (*CARequestCallback)(const CAEndpoint_t *object,
688                                   const CARequestInfo_t *requestInfo);
689
690 /**
691  * Callback function type for response delivery.
692  * @param[out]   object           Endpoint object from which the response is received.
693  * @param[out]   responseInfo     Identifier which needs to be mapped with response.
694  */
695 typedef void (*CAResponseCallback)(const CAEndpoint_t *object,
696                                    const CAResponseInfo_t *responseInfo);
697 /**
698  * Callback function type for error.
699  * @param[out]   object           remote device information.
700  * @param[out]   errorInfo        CA Error information.
701  */
702 typedef void (*CAErrorCallback)(const CAEndpoint_t *object,
703                                 const CAErrorInfo_t *errorInfo);
704
705 /**
706  * Callback function type for error.
707  * @param[out]   object           remote device information.
708  * @param[out]   result           error information.
709  */
710 typedef CAResult_t (*CAHandshakeErrorCallback)(const CAEndpoint_t *object,
711                                                const CAErrorInfo_t *errorInfo);
712
713 /**
714  * Callback function type for network status changes delivery from CA common logic.
715  * @param[out]   info       Endpoint object from which the network status is changed.
716  *                          It contains endpoint address based on the connectivity type.
717  * @param[out]   status     Current network status info.
718  */
719 typedef void (*CANetworkMonitorCallback)(const CAEndpoint_t *info, CANetworkStatus_t status);
720
721 #ifdef __cplusplus
722 } /* extern "C" */
723 #endif
724
725 #endif // CA_COMMON_H_