Support Signaling Message for CoAP over TCP
[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  * Option numbers for Signaling messages are specific to the message code.
144  * They do not share the number space with CoAP options for request/response
145  * messages or with Signaling messages using other codes.
146  */
147 #define CA_OPTION_SERVER_NAME_SETTING 1    /**< Capability and Settings messages, code=7.01 */
148 #define CA_OPTION_MAX_MESSAGE_SIZE 2       /**< Capability and Settings messages, code=7.01 */
149 #define CA_OPTION_BLOCK_WISE_TRANSFER 4    /**< Capability and Settings messages, code=7.01 */
150 #define CA_OPTION_CUSTODY 2                /**< Ping and Pong Messages, code=7.02 */
151 #define CA_OPTION_BAD_SERVER_NAME 2        /**< Release Messages, code=7.04 */
152 #define CA_OPTION_ALTERNATE_ADDRESS 4      /**< Abort Messages, code=7.05 */
153 #define CA_OPTION_HOLD_OFF 6               /**< Abort Messages, code=7.05 */
154
155 /**
156  * Payload information from resource model.
157  */
158 typedef uint8_t *CAPayload_t;
159
160 /**
161  * URI for the OIC base.CA considers relative URI as the URI.
162  */
163 typedef char *CAURI_t;
164
165 /**
166  * Token information for mapping the request and responses by resource model.
167  */
168 typedef char *CAToken_t;
169
170 /*
171  * Socket types and error definitions.
172  */
173 #ifdef HAVE_WINSOCK2_H
174 # define OC_SOCKET_ERROR      SOCKET_ERROR
175 # define OC_INVALID_SOCKET    INVALID_SOCKET
176 typedef SOCKET CASocketFd_t;
177 #else // HAVE_WINSOCK2_H
178 # define OC_SOCKET_ERROR      (-1)
179 # define OC_INVALID_SOCKET    (-1)
180 typedef int    CASocketFd_t;
181 #endif
182
183 /*
184  * The following flags are the same as the equivalent OIC values in
185  * octypes.h, allowing direct copying with slight fixup.
186  * The CA layer should used the OC types when build allows that.
187  */
188 #ifdef RA_ADAPTER
189 #define MAX_ADDR_STR_SIZE_CA (256)
190 #else
191 /*
192  * Max Address could be "coaps+tcp://[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:yyy.yyy.yyy.yyy]:xxxxx"
193  * Which is 65, +1 for null terminator => 66
194  * OCDevAddr (defined in OCTypes.h) must be the same
195  * as CAEndpoint_t (defined here)
196  */
197 #define MAX_ADDR_STR_SIZE_CA (66)
198 #endif
199
200 typedef enum
201 {
202     CA_DEFAULT_ADAPTER = 0,
203
204     // value zero indicates discovery
205     CA_ADAPTER_IP            = (1 << 0),   // IPv4 and IPv6, including 6LoWPAN
206     CA_ADAPTER_GATT_BTLE     = (1 << 1),   // GATT over Bluetooth LE
207     CA_ADAPTER_RFCOMM_BTEDR  = (1 << 2),   // RFCOMM over Bluetooth EDR
208
209 #ifdef RA_ADAPTER
210     CA_ADAPTER_REMOTE_ACCESS = (1 << 3),   // Remote Access over XMPP.
211 #endif
212
213     CA_ADAPTER_TCP           = (1 << 4),   // CoAP over TCP
214     CA_ADAPTER_NFC           = (1 << 5),   // NFC Adapter
215
216     CA_ALL_ADAPTERS          = 0xffffffff
217 } CATransportAdapter_t;
218
219 typedef enum
220 {
221     CA_DEFAULT_FLAGS = 0,
222
223     // Insecure transport is the default (subject to change)
224     CA_SECURE          = (1 << 4),   // secure the transport path
225     // IPv4 & IPv6 autoselection is the default
226     CA_IPV6            = (1 << 5),   // IP adapter only
227     CA_IPV4            = (1 << 6),   // IP adapter only
228     // Indication that a message was received by multicast.
229     CA_MULTICAST       = (1 << 7),
230     // Link-Local multicast is the default multicast scope for IPv6.
231     // These correspond in both value and position to the IPv6 address bits.
232     CA_SCOPE_INTERFACE = 0x1, // IPv6 Interface-Local scope
233     CA_SCOPE_LINK      = 0x2, // IPv6 Link-Local scope (default)
234     CA_SCOPE_REALM     = 0x3, // IPv6 Realm-Local scope
235     CA_SCOPE_ADMIN     = 0x4, // IPv6 Admin-Local scope
236     CA_SCOPE_SITE      = 0x5, // IPv6 Site-Local scope
237     CA_SCOPE_ORG       = 0x8, // IPv6 Organization-Local scope
238     CA_SCOPE_GLOBAL    = 0xE, // IPv6 Global scope
239 } CATransportFlags_t;
240
241 typedef enum
242 {
243     CA_DEFAULT_BT_FLAGS = 0,
244     // flags for BLE transport
245     CA_LE_ADV_DISABLE   = 0x1,   // disable BLE advertisement.
246     CA_LE_ADV_ENABLE    = 0x2,   // enable BLE advertisement.
247     CA_LE_SERVER_DISABLE = (1 << 4),   // disable gatt server.
248     // flags for EDR transport
249     CA_EDR_SERVER_DISABLE = (1 << 7)
250 } CATransportBTFlags_t;
251
252 #define CA_IPFAMILY_MASK (CA_IPV6|CA_IPV4)
253 #define CA_SCOPE_MASK 0xf     // mask scope bits above
254
255 /**
256  * Information about the network status.
257  */
258 typedef enum
259 {
260     CA_INTERFACE_DOWN,   /**< Connection is not available */
261     CA_INTERFACE_UP    /**< Connection is Available */
262 } CANetworkStatus_t;
263
264 /*
265  * remoteEndpoint identity.
266  */
267 typedef struct
268 {
269     uint16_t id_length;
270     unsigned char id[CA_MAX_ENDPOINT_IDENTITY_LEN];
271 } CARemoteId_t;
272
273 /**
274  * Message Type for Base source code.
275  */
276 typedef enum
277 {
278     CA_MSG_CONFIRM = 0,  /**< confirmable message (requires ACK/RST) */
279     CA_MSG_NONCONFIRM,   /**< non-confirmable message (one-shot message) */
280     CA_MSG_ACKNOWLEDGE,  /**< used to acknowledge confirmable messages */
281     CA_MSG_RESET         /**< used to indicates not-interested or error (lack of context)in
282                                                   received messages */
283 } CAMessageType_t;
284
285 /**
286  * Allowed method to be used by resource model.
287  */
288 typedef enum
289 {
290     CA_GET = 1, /**< GET Method  */
291     CA_POST,    /**< POST Method */
292     CA_PUT,     /**< PUT Method */
293     CA_DELETE   /**< DELETE Method */
294 } CAMethod_t;
295
296 /**
297  * block size.
298  * it depends on defined size in libCoAP.
299  */
300 typedef enum
301 {
302     CA_BLOCK_SIZE_16_BYTE = 0,    /**< 16byte */
303     CA_BLOCK_SIZE_32_BYTE = 1,    /**< 32byte */
304     CA_BLOCK_SIZE_64_BYTE = 2,    /**< 64byte */
305     CA_BLOCK_SIZE_128_BYTE = 3,   /**< 128byte */
306     CA_BLOCK_SIZE_256_BYTE = 4,   /**< 256byte */
307     CA_BLOCK_SIZE_512_BYTE = 5,   /**< 512byte */
308     CA_BLOCK_SIZE_1024_BYTE = 6     /**< 1Kbyte */
309 } CABlockSize_t;
310
311 /**
312  * Endpoint information for connectivities.
313  * Must be identical to OCDevAddr.
314  */
315 typedef struct
316 {
317     CATransportAdapter_t    adapter;    // adapter type
318     CATransportFlags_t      flags;      // transport modifiers
319     uint16_t                port;       // for IP
320     char                    addr[MAX_ADDR_STR_SIZE_CA]; // address for all
321     uint32_t                ifindex;    // usually zero for default interface
322     char                    remoteId[CA_MAX_IDENTITY_SIZE]; // device ID of remote device
323 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
324     char                    routeData[MAX_ADDR_STR_SIZE_CA]; /**< GatewayId:ClientId of
325                                                                     destination. **/
326 #endif
327 } CAEndpoint_t;
328
329 #define CA_SECURE_ENDPOINT_PUBLIC_KEY_MAX_LENGTH    (512)
330
331 /**
332  * Endpoint information for secure messages.
333  */
334 typedef struct
335 {
336     CAEndpoint_t endpoint;      /**< endpoint */
337     // TODO change name to deviceId
338     CARemoteId_t identity;      /**< endpoint device uuid */
339     CARemoteId_t userId;        /**< endpoint user uuid */
340     uint32_t attributes;
341     uint8_t publicKey[CA_SECURE_ENDPOINT_PUBLIC_KEY_MAX_LENGTH]; /**< Peer's DER-encoded public key (if using certificate) */
342     size_t publicKeyLength;     /**< Length of publicKey; zero if not using certificate */
343 } CASecureEndpoint_t;
344
345 /**
346  * Endpoint used for security administration - a special type of identity that
347  * bypasses Access Control Entry checks for SVR resources, while the device is
348  * not ready for normal operation yet.
349  */
350 #define CA_SECURE_ENDPOINT_ATTRIBUTE_ADMINISTRATOR  0x1
351
352 /**
353  * Enums for CA return values.
354  */
355 typedef enum
356 {
357     /* Result code - START HERE */
358     CA_STATUS_OK = 0,               /**< Success */
359     CA_STATUS_INVALID_PARAM,        /**< Invalid Parameter */
360     CA_ADAPTER_NOT_ENABLED,         /**< Adapter is not enabled */
361     CA_SERVER_STARTED_ALREADY,      /**< Server is started already */
362     CA_SERVER_NOT_STARTED,          /**< Server is not started */
363     CA_DESTINATION_NOT_REACHABLE,   /**< Destination is not reachable */
364     CA_SOCKET_OPERATION_FAILED,     /**< Socket operation failed */
365     CA_SEND_FAILED,                 /**< Send request failed */
366     CA_RECEIVE_FAILED,              /**< Receive failed */
367     CA_MEMORY_ALLOC_FAILED,         /**< Memory allocation failed */
368     CA_REQUEST_TIMEOUT,             /**< Request is Timeout */
369     CA_DESTINATION_DISCONNECTED,    /**< Destination is disconnected */
370     CA_NOT_SUPPORTED,               /**< Not supported */
371     CA_STATUS_NOT_INITIALIZED,      /**< Not Initialized*/
372     CA_DTLS_AUTHENTICATION_FAILURE, /**< Decryption error in DTLS */
373     CA_CONTINUE_OPERATION,          /**< Error happens but current operation should continue */
374     CA_HANDLE_ERROR_OTHER_MODULE,   /**< Error happens but it should be handled in other module */
375     CA_STATUS_NOT_FOUND,            /**< Not Found*/
376     CA_STATUS_FAILED =255           /**< Failure */
377     /* Result code - END HERE */
378 } CAResult_t;
379
380 /**
381  * Enums for CA Response values.
382  */
383 typedef enum
384 {
385     /* Response status code - START HERE */
386     CA_EMPTY = 0,                           /**< Empty */
387     CA_CREATED = 201,                       /**< Created */
388     CA_DELETED = 202,                       /**< Deleted */
389     CA_VALID = 203,                         /**< Valid */
390     CA_CHANGED = 204,                       /**< Changed */
391     CA_CONTENT = 205,                       /**< Content */
392     CA_CONTINUE = 231,                      /**< Continue */
393     CA_BAD_REQ = 400,                       /**< Bad Request */
394     CA_UNAUTHORIZED_REQ = 401,              /**< Unauthorized Request */
395     CA_BAD_OPT = 402,                       /**< Bad Option */
396     CA_FORBIDDEN_REQ = 403,                 /**< Forbidden Request */
397     CA_NOT_FOUND = 404,                     /**< Not found */
398     CA_METHOD_NOT_ALLOWED = 405,            /**< Method Not Allowed */
399     CA_NOT_ACCEPTABLE = 406,                /**< Not Acceptable */
400     CA_REQUEST_ENTITY_INCOMPLETE = 408,     /**< Request Entity Incomplete */
401     CA_REQUEST_ENTITY_TOO_LARGE = 413,      /**< Request Entity Too Large */
402     CA_INTERNAL_SERVER_ERROR = 500,         /**< Internal Server Error */
403     CA_BAD_GATEWAY = 502,
404     CA_SERVICE_UNAVAILABLE = 503,           /**< Server Unavailable */
405     CA_RETRANSMIT_TIMEOUT = 504,            /**< Retransmit timeout */
406     CA_PROXY_NOT_SUPPORTED = 505            /**< Proxy not enabled to service a request */
407     /* Response status code - END HERE */
408 } CAResponseResult_t;
409
410 /**
411  * Enums for CA Signaling codes.
412  */
413 typedef enum
414 {
415     /* Signaling code - START HERE */
416     CA_CSM = 701,                           /**< Capability and Settings messages */
417     CA_PING = 702,                          /**< Ping messages */
418     CA_PONG = 703,                          /**< Pong messages */
419     CA_RELEASE = 704,                       /**< Release messages */
420     CA_ABORT = 705,                         /**< Abort messages */
421     /* Signaling code - END HERE */
422 } CASignalingCode_t;
423
424 /**
425  * Data type whether the data is Request Message or Response Message.
426  * if there is some failure before send data on network.
427  * Type will be set as error type for error callback.
428  */
429 typedef enum
430 {
431     CA_REQUEST_DATA = 1,
432     CA_RESPONSE_DATA,
433     CA_ERROR_DATA,
434     CA_RESPONSE_FOR_RES,
435     CA_SIGNALING_DATA
436 } CADataType_t;
437
438 /**
439  * Transport Protocol IDs for additional options.
440  */
441 typedef enum
442 {
443     CA_INVALID_ID = (1 << 0),   /**< Invalid ID */
444     CA_COAP_ID = (1 << 1)       /**< COAP ID */
445 } CATransportProtocolID_t;
446
447 /**
448  * Adapter State to indicate the network changed notifications.
449  */
450 typedef enum
451 {
452     CA_ADAPTER_DISABLED,   /**< Adapter is Disabled */
453     CA_ADAPTER_ENABLED     /**< Adapter is Enabled */
454 } CAAdapterState_t;
455
456 /**
457  * Format indicating which encoding has been used on the payload.
458  */
459 typedef enum
460 {
461     CA_FORMAT_UNDEFINED = 0,            /**< Undefined enoding format */
462     CA_FORMAT_TEXT_PLAIN,
463     CA_FORMAT_APPLICATION_LINK_FORMAT,
464     CA_FORMAT_APPLICATION_XML,
465     CA_FORMAT_APPLICATION_OCTET_STREAM,
466     CA_FORMAT_APPLICATION_RDF_XML,
467     CA_FORMAT_APPLICATION_EXI,
468     CA_FORMAT_APPLICATION_JSON,
469     CA_FORMAT_APPLICATION_CBOR,
470     CA_FORMAT_APPLICATION_VND_OCF_CBOR,
471     CA_FORMAT_UNSUPPORTED
472 } CAPayloadFormat_t;
473
474 /**
475  * Option ID of header option. The values match CoAP option types in pdu.h.
476  */
477 typedef enum
478 {
479     CA_HEADER_OPTION_ID_LOCATION_PATH = 8,
480     CA_HEADER_OPTION_ID_LOCATION_QUERY = 20
481 } CAHeaderOptionId_t;
482
483 /**
484  * Header options structure to be filled.
485  *
486  * This structure is used to hold header information.
487  */
488 typedef struct
489 {
490     CATransportProtocolID_t protocolID;                     /**< Protocol ID of the Option */
491     uint16_t optionID;                                      /**< The header option ID which will be
492                                                             added to communication packets */
493     uint16_t optionLength;                                  /**< Option Length **/
494     char optionData[CA_MAX_HEADER_OPTION_DATA_LENGTH];      /**< Optional data values**/
495 } CAHeaderOption_t;
496
497 /**
498  * Base Information received.
499  *
500  * This structure is used to hold request & response base information.
501  */
502 typedef struct
503 {
504     CAMessageType_t type;       /**< Qos for the request */
505 #ifdef ROUTING_GATEWAY
506     bool skipRetransmission;    /**< Will not attempt retransmission even if type is CONFIRM.
507                                      Required for packet forwarding */
508 #endif
509     uint16_t messageId;         /**< Message id.
510                                  * if message id is zero, it will generated by CA inside.
511                                  * otherwise, you can use it */
512     CAToken_t token;            /**< Token for CA */
513     uint8_t tokenLength;        /**< token length */
514     CAHeaderOption_t *options;  /** Header Options for the request */
515     uint8_t numOptions;         /**< Number of Header options */
516     CAPayload_t payload;        /**< payload of the request  */
517     size_t payloadSize;         /**< size in bytes of the payload */
518     CAPayloadFormat_t payloadFormat;    /**< encoding format of the request payload */
519     CAPayloadFormat_t acceptFormat;     /**< accept format for the response payload */
520     uint16_t payloadVersion;    /**< version of the payload */
521     uint16_t acceptVersion;     /**< expected version for the response payload */
522     CAURI_t resourceUri;        /**< Resource URI information **/
523     CARemoteId_t identity;      /**< endpoint identity */
524     CADataType_t dataType;      /**< data type */
525 } CAInfo_t;
526
527 /**
528  * Request Information to be sent.
529  *
530  * This structure is used to hold request information.
531  */
532 typedef struct
533 {
534     CAMethod_t method;  /**< Name of the Method Allowed */
535     CAInfo_t info;      /**< Information of the request. */
536     bool isMulticast;   /**< is multicast request */
537 } CARequestInfo_t;
538
539 /**
540  * Response information received.
541  *
542  * This structure is used to hold response information.
543  */
544 typedef struct
545 {
546     CAResponseResult_t result;  /**< Result for response by resource model */
547     CAInfo_t info;              /**< Information of the response */
548     bool isMulticast;
549 } CAResponseInfo_t;
550
551 /**
552  * Error information from CA
553  *        contains error code and message information.
554  *
555  * This structure holds error information.
556  */
557 typedef struct
558 {
559     CAResult_t result;  /**< CA API request result  */
560     CAInfo_t info;      /**< message information such as token and payload data
561                              helpful to identify the error */
562 } CAErrorInfo_t;
563
564 /**
565  * Signaling information received.
566  *
567  * This structure is used to hold signaling information.
568  */
569 typedef struct
570 {
571     CASignalingCode_t code;
572     CAInfo_t info;              /**< Information of the signaling */
573 } CASignalingInfo_t;
574
575 /**
576  * Hold global variables for CA layer. (also used by RI layer)
577  */
578 typedef struct
579 {
580     CASocketFd_t fd;    /**< socket fd */
581     uint16_t port;      /**< socket port */
582 } CASocket_t;
583
584 #define HISTORYSIZE (4)
585
586 typedef struct
587 {
588     CATransportFlags_t flags;
589     uint16_t messageId;
590     char token[CA_MAX_TOKEN_LEN];
591     uint8_t tokenLength;
592     uint32_t ifindex;
593 } CAHistoryItem_t;
594
595 typedef struct
596 {
597     int nextIndex;
598     CAHistoryItem_t items[HISTORYSIZE];
599 } CAHistory_t;
600
601 /**
602  * Hold interface index for keeping track of comings and goings.
603  */
604 typedef struct
605 {
606     int32_t ifIndex; /**< network interface index */
607 } CAIfItem_t;
608
609 /**
610  * Hold the port number assigned from application.
611  * It will be used when creating a socket.
612  */
613 typedef struct
614 {
615     struct udpports
616     {
617         uint16_t u6;    /**< unicast IPv6 socket port */
618         uint16_t u6s;   /**< unicast IPv6 socket secure port */
619         uint16_t u4;    /**< unicast IPv4 socket port */
620         uint16_t u4s;   /**< unicast IPv4 socket secure port */
621     } udp;
622 #ifdef TCP_ADAPTER
623     struct tcpports
624     {
625         uint16_t u4;    /**< unicast IPv4 socket port */
626         uint16_t u4s;   /**< unicast IPv6 socket secure port */
627         uint16_t u6;    /**< unicast IPv6 socket port */
628         uint16_t u6s;   /**< unicast IPv6 socket secure port */
629     } tcp;
630 #endif
631 } CAPorts_t;
632
633 typedef struct
634 {
635     CATransportFlags_t clientFlags; /**< flag for client */
636     CATransportFlags_t serverFlags; /**< flag for server */
637     bool client; /**< client mode */
638     bool server; /**< server mode */
639
640     CAPorts_t ports;
641
642     struct sockets
643     {
644         void *threadpool;           /**< threadpool between Initialize and Start */
645         CASocket_t u6;              /**< unicast   IPv6 */
646         CASocket_t u6s;             /**< unicast   IPv6 secure */
647         CASocket_t u4;              /**< unicast   IPv4 */
648         CASocket_t u4s;             /**< unicast   IPv4 secure */
649         CASocket_t m6;              /**< multicast IPv6 */
650         CASocket_t m6s;             /**< multicast IPv6 secure */
651         CASocket_t m4;              /**< multicast IPv4 */
652         CASocket_t m4s;             /**< multicast IPv4 secure */
653 #if defined(_WIN32)
654         WSAEVENT addressChangeEvent;/**< Event used to signal address changes */
655         WSAEVENT shutdownEvent;     /**< Event used to signal threads to stop */
656 #else
657         int netlinkFd;              /**< netlink */
658         int shutdownFds[2];         /**< fds used to signal threads to stop */
659         CASocketFd_t maxfd;         /**< highest fd (for select) */
660 #endif
661         int selectTimeout;          /**< in seconds */
662         bool started;               /**< the IP adapter has started */
663         bool terminate;             /**< the IP adapter needs to stop */
664         bool ipv6enabled;           /**< IPv6 enabled by OCInit flags */
665         bool ipv4enabled;           /**< IPv4 enabled by OCInit flags */
666         bool dualstack;             /**< IPv6 and IPv4 enabled */
667 #if defined (_WIN32)
668         LPFN_WSARECVMSG wsaRecvMsg; /**< Win32 function pointer to WSARecvMsg() */
669 #endif
670
671         struct networkmonitors
672         {
673             CAIfItem_t *ifItems; /**< current network interface index list */
674             size_t sizeIfItems;  /**< size of network interface index array */
675             size_t numIfItems;   /**< number of valid network interfaces */
676         } nm;
677     } ip;
678
679     struct calayer
680     {
681         CAHistory_t requestHistory;  /**< filter IP family in requests */
682     } ca;
683
684 #ifdef TCP_ADAPTER
685     /**
686      * Hold global variables for TCP Adapter.
687      */
688     struct tcpsockets
689     {
690         void *threadpool;       /**< threadpool between Initialize and Start */
691         CASocket_t ipv4;        /**< IPv4 accept socket */
692         CASocket_t ipv4s;       /**< IPv4 accept socket secure */
693         CASocket_t ipv6;        /**< IPv6 accept socket */
694         CASocket_t ipv6s;       /**< IPv6 accept socket secure */
695         int selectTimeout;      /**< in seconds */
696         int listenBacklog;      /**< backlog counts*/
697 #if defined(_WIN32)
698         WSAEVENT updateEvent;   /**< Event used to signal thread to stop or update the FD list */
699 #else
700         int shutdownFds[2];     /**< shutdown pipe */
701         int connectionFds[2];   /**< connection pipe */
702         CASocketFd_t maxfd;     /**< highest fd (for select) */
703 #endif
704         bool started;           /**< the TCP adapter has started */
705         volatile bool terminate;/**< the TCP adapter needs to stop */
706         bool ipv4tcpenabled;    /**< IPv4 TCP enabled by OCInit flags */
707         bool ipv6tcpenabled;    /**< IPv6 TCP enabled by OCInit flags */
708     } tcp;
709 #endif
710     CATransportBTFlags_t bleFlags;   /**< flags related BLE transport */
711 } CAGlobals_t;
712
713 extern CAGlobals_t caglobals;
714
715 typedef enum
716 {
717     CA_LOG_LEVEL_ALL = 1,             // all logs.
718     CA_LOG_LEVEL_INFO,                // debug level is disabled.
719 } CAUtilLogLevel_t;
720
721 /**
722  * Callback function type for request delivery.
723  * @param[out]   object       Endpoint object from which the request is received.
724  *                            It contains endpoint address based on the connectivity type.
725  * @param[out]   requestInfo  Info for resource model to understand about the request.
726  */
727 typedef void (*CARequestCallback)(const CAEndpoint_t *object,
728                                   const CARequestInfo_t *requestInfo);
729
730 /**
731  * Callback function type for response delivery.
732  * @param[out]   object           Endpoint object from which the response is received.
733  * @param[out]   responseInfo     Identifier which needs to be mapped with response.
734  */
735 typedef void (*CAResponseCallback)(const CAEndpoint_t *object,
736                                    const CAResponseInfo_t *responseInfo);
737 /**
738  * Callback function type for error.
739  * @param[out]   object           remote device information.
740  * @param[out]   errorInfo        CA Error information.
741  */
742 typedef void (*CAErrorCallback)(const CAEndpoint_t *object,
743                                 const CAErrorInfo_t *errorInfo);
744
745 /**
746  * Callback function type for error.
747  * @param[out]   object           remote device information.
748  * @param[out]   result           error information.
749  */
750 typedef CAResult_t (*CAHandshakeErrorCallback)(const CAEndpoint_t *object,
751                                                const CAErrorInfo_t *errorInfo);
752
753 /**
754  * Callback function type for network status changes delivery from CA common logic.
755  * @param[out]   info       Endpoint object from which the network status is changed.
756  *                          It contains endpoint address based on the connectivity type.
757  * @param[out]   status     Current network status info.
758  */
759 typedef void (*CANetworkMonitorCallback)(const CAEndpoint_t *info, CANetworkStatus_t status);
760
761 #ifdef __cplusplus
762 } /* extern "C" */
763 #endif
764
765 #endif // CA_COMMON_H_