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 #ifndef WITH_ARDUINO
  30 #ifdef TCP_ADAPTER
  31 #define HAVE_SYS_POLL_H
  32 #endif
  33 #endif
  34
  35 #include <stdint.h>
  36 #include <stdlib.h>
  37 #include <stdbool.h>
  38
  39 #ifdef HAVE_SYS_POLL_H
  40 #include <sys/poll.h>
  41 #endif
  42
  43 #ifdef HAVE_WINSOCK2_H
  44 #include <winsock2.h>
  45 #include <mswsock.h>
  46 #endif
  47
  48 #ifdef __cplusplus
  49 extern "C"
  50 {
  51 #endif
  52
  53 /**
  54  * IP address Length
  55  */
  56 #define CA_IPADDR_SIZE 16
  57
  58 /**
  59  * Remote Access jabber ID length.
  60  */
  61 #define CA_RAJABBERID_SIZE 256
  62
  63 /**
  64  * Mac address length for BT port
  65  */
  66 #define CA_MACADDR_SIZE 18
  67
  68 /**
  69  * Max header options data length
  70  */
  71 #define CA_MAX_HEADER_OPTION_DATA_LENGTH 20
  72
  73 /**
  74 * Max token length
  75 */
  76 #define CA_MAX_TOKEN_LEN (8)
  77
  78 /**
  79  * Max URI length
  80  */
  81 #ifdef ARDUINO
  82 #define CA_MAX_URI_LENGTH 128  /* maximum size of URI for embedded platforms*/
  83 #else
  84 #define CA_MAX_URI_LENGTH 512 /* maximum size of URI for other platforms*/
  85 #endif
  86
  87 /**
  88  * Max PDU length supported
  89  */
  90 #ifdef ARDUINO
  91 #define COAP_MAX_PDU_SIZE           320  /* maximum size of a CoAP PDU for embedded platforms*/
  92 #else
  93 #define COAP_MAX_PDU_SIZE           1400 /* maximum size of a CoAP PDU for big platforms*/
  94 #endif
  95
  96 #ifdef WITH_BWT
  97 #define CA_DEFAULT_BLOCK_SIZE       CA_BLOCK_SIZE_1024_BYTE
  98 #endif
  99
 100 /**
 101  *Maximum length of the remoteEndpoint identity
 102  */
 103 #define CA_MAX_ENDPOINT_IDENTITY_LEN   (32)
 104
 105 /**
 106  * option types - the highest option number 63
 107  */
 108 #define CA_OPTION_IF_MATCH 1
 109 #define CA_OPTION_ETAG 4
 110 #define CA_OPTION_IF_NONE_MATCH 5
 111 #define CA_OPTION_OBSERVE 6
 112 #define CA_OPTION_LOCATION_PATH 8
 113 #define CA_OPTION_URI_PATH 11
 114 #define CA_OPTION_CONTENT_FORMAT 12
 115 #define CA_OPTION_CONTENT_TYPE COAP_OPTION_CONTENT_FORMAT
 116 #define CA_OPTION_MAXAGE 14
 117 #define CA_OPTION_URI_QUERY 15
 118 #define CA_OPTION_ACCEPT 17
 119 #define CA_OPTION_LOCATION_QUERY 20
 120
 121 /**
 122  * Payload information from resource model
 123  */
 124 typedef uint8_t *CAPayload_t;
 125
 126 /**
 127  * URI for the OIC base.CA considers relative URI as the URI.
 128  */
 129 typedef char *CAURI_t;
 130
 131 /**
 132  * Token information for mapping the request and responses by resource model
 133  */
 134 typedef char *CAToken_t;
 135
 136 /*
 137  * Socket types and error definitions
 138  */
 139 #ifdef HAVE_WINSOCK2_H
 140 # define OC_SOCKET_ERROR      SOCKET_ERROR
 141 # define OC_INVALID_SOCKET    INVALID_SOCKET
 142 typedef SOCKET CASocketFd_t;
 143 #else // HAVE_WINSOCK2_H
 144 # define OC_SOCKET_ERROR      (-1)
 145 # define OC_INVALID_SOCKET    (-1)
 146 typedef int    CASocketFd_t;
 147 #endif
 148
 149 /*
 150  * The following flags are the same as the equivalent OIC values in
 151  * octypes.h, allowing direct copying with slight fixup.
 152  * The CA layer should used the OC types when build allows that.
 153  */
 154 #ifdef RA_ADAPTER
 155 #define MAX_ADDR_STR_SIZE_CA (256)
 156 #else
 157 /*
 158  * Max Address could be "coap+tcp://[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:yyy.yyy.yyy.yyy]:xxxxx"
 159  * Which is 64, +1 for null terminator => 65
 160  * OCDevAddr (defined in OCTypes.h) must be the same
 161  * as CAEndpoint_t (defined here)
 162  */
 163 #define MAX_ADDR_STR_SIZE_CA (65)
 164 #endif
 165
 166 typedef enum
 167 {
 168     CA_DEFAULT_ADAPTER = 0,
 169
 170     // value zero indicates discovery
 171     CA_ADAPTER_IP            = (1 << 0),   // IPv4 and IPv6, including 6LoWPAN
 172     CA_ADAPTER_GATT_BTLE     = (1 << 1),   // GATT over Bluetooth LE
 173     CA_ADAPTER_RFCOMM_BTEDR  = (1 << 2),   // RFCOMM over Bluetooth EDR
 174
 175 #ifdef RA_ADAPTER
 176     CA_ADAPTER_REMOTE_ACCESS = (1 << 3),   // Remote Access over XMPP.
 177 #endif
 178
 179     CA_ADAPTER_TCP           = (1 << 4),   // CoAP over TCP
 180     CA_ADAPTER_NFC           = (1 << 5),   // NFC Adapter
 181
 182     CA_ALL_ADAPTERS          = 0xffffffff
 183 } CATransportAdapter_t;
 184
 185 typedef enum
 186 {
 187     CA_DEFAULT_FLAGS = 0,
 188
 189     // Insecure transport is the default (subject to change)
 190     CA_SECURE          = (1 << 4),   // secure the transport path
 191     // IPv4 & IPv6 autoselection is the default
 192     CA_IPV6            = (1 << 5),   // IP adapter only
 193     CA_IPV4            = (1 << 6),   // IP adapter only
 194     // Indication that a message was received by multicast.
 195     CA_MULTICAST       = (1 << 7),
 196     // Link-Local multicast is the default multicast scope for IPv6.
 197     // These correspond in both value and position to the IPv6 address bits.
 198     CA_SCOPE_INTERFACE = 0x1, // IPv6 Interface-Local scope
 199     CA_SCOPE_LINK      = 0x2, // IPv6 Link-Local scope (default)
 200     CA_SCOPE_REALM     = 0x3, // IPv6 Realm-Local scope
 201     CA_SCOPE_ADMIN     = 0x4, // IPv6 Admin-Local scope
 202     CA_SCOPE_SITE      = 0x5, // IPv6 Site-Local scope
 203     CA_SCOPE_ORG       = 0x8, // IPv6 Organization-Local scope
 204     CA_SCOPE_GLOBAL    = 0xE, // IPv6 Global scope
 205 } CATransportFlags_t;
 206
 207 #define CA_IPFAMILY_MASK (CA_IPV6|CA_IPV4)
 208 #define CA_SCOPE_MASK 0xf     // mask scope bits above
 209
 210 /**
 211  * @enum CANetworkStatus_t
 212  * Information about the network status.
 213  */
 214 typedef enum
 215 {
 216     CA_INTERFACE_DOWN,   /**< Connection is not available */
 217     CA_INTERFACE_UP    /**< Connection is Available */
 218 } CANetworkStatus_t;
 219
 220 /*
 221  * remoteEndpoint identity
 222  */
 223 typedef struct
 224 {
 225     uint16_t id_length;
 226     unsigned char id[CA_MAX_ENDPOINT_IDENTITY_LEN];
 227 } CARemoteId_t;
 228
 229 /**
 230  * @enum CAMessageType_t
 231  * Message Type for Base source code
 232  */
 233 typedef enum
 234 {
 235     CA_MSG_CONFIRM = 0,  /**< confirmable message (requires ACK/RST) */
 236     CA_MSG_NONCONFIRM,   /**< non-confirmable message (one-shot message) */
 237     CA_MSG_ACKNOWLEDGE,  /**< used to acknowledge confirmable messages */
 238     CA_MSG_RESET         /**< used to indicates not-interested or error (lack of context)in
 239                                                   received messages */
 240 } CAMessageType_t;
 241
 242 /**
 243  * @enum CAMethod_t
 244  * Allowed method to be used by resource model
 245  */
 246 typedef enum
 247 {
 248     CA_GET = 1, /**< GET Method  */
 249     CA_POST,    /**< POST Method */
 250     CA_PUT,     /**< PUT Method */
 251     CA_DELETE   /**< DELETE Method */
 252 } CAMethod_t;
 253
 254 /**
 255  * block size
 256  * it depends on defined size in libCoAP.
 257  */
 258 typedef enum
 259 {
 260     CA_BLOCK_SIZE_16_BYTE = 0,    /**< 16byte */
 261     CA_BLOCK_SIZE_32_BYTE = 1,    /**< 32byte */
 262     CA_BLOCK_SIZE_64_BYTE = 2,    /**< 64byte */
 263     CA_BLOCK_SIZE_128_BYTE = 3,   /**< 128byte */
 264     CA_BLOCK_SIZE_256_BYTE = 4,   /**< 256byte */
 265     CA_BLOCK_SIZE_512_BYTE = 5,   /**< 512byte */
 266     CA_BLOCK_SIZE_1024_BYTE = 6     /**< 1Kbyte */
 267 } CABlockSize_t;
 268
 269 /**
 270  * Endpoint information for connectivities
 271  * Must be identical to OCDevAddr.
 272  */
 273 typedef struct
 274 {
 275     CATransportAdapter_t    adapter;    // adapter type
 276     CATransportFlags_t      flags;      // transport modifiers
 277     uint16_t                port;       // for IP
 278     char                    addr[MAX_ADDR_STR_SIZE_CA]; // address for all
 279     uint32_t                ifindex;    // usually zero for default interface
 280 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
 281     char                    routeData[MAX_ADDR_STR_SIZE_CA]; /**< GatewayId:ClientId of
 282                                                                     destination. **/
 283 #endif
 284 } CAEndpoint_t;
 285
 286 /**
 287  * Endpoint information for secure messages
 288  */
 289 typedef struct
 290 {
 291     CAEndpoint_t endpoint;      /**< endpoint */
 292     CARemoteId_t identity;      /**< endpoint identity */
 293 } CASecureEndpoint_t;
 294
 295 /**
 296  * @enum CAResult_t
 297  * Enums for CA return values
 298  */
 299 typedef enum
 300 {
 301     /* Result code - START HERE */
 302     CA_STATUS_OK = 0,               /**< Success */
 303     CA_STATUS_INVALID_PARAM,        /**< Invalid Parameter */
 304     CA_ADAPTER_NOT_ENABLED,         /**< Adapter is not enabled */
 305     CA_SERVER_STARTED_ALREADY,      /**< Server is started already */
 306     CA_SERVER_NOT_STARTED,          /**< Server is not started */
 307     CA_DESTINATION_NOT_REACHABLE,   /**< Destination is not reachable */
 308     CA_SOCKET_OPERATION_FAILED,     /**< Socket operation failed */
 309     CA_SEND_FAILED,                 /**< Send request failed */
 310     CA_RECEIVE_FAILED,              /**< Receive failed */
 311     CA_MEMORY_ALLOC_FAILED,         /**< Memory allocation failed */
 312     CA_REQUEST_TIMEOUT,             /**< Request is Timeout */
 313     CA_DESTINATION_DISCONNECTED,    /**< Destination is disconnected */
 314     CA_NOT_SUPPORTED,               /**< Not supported */
 315     CA_STATUS_NOT_INITIALIZED,      /**< Not Initialized*/
 316     CA_DTLS_AUTHENTICATION_FAILURE, /**< Decryption error in DTLS */
 317     CA_STATUS_FAILED =255           /**< Failure */
 318     /* Result code - END HERE */
 319 } CAResult_t;
 320
 321 /**
 322  * @enum CAResponseResult_t
 323  * Enums for CA Response values
 324  */
 325 typedef enum
 326 {
 327     /* Response status code - START HERE */
 328     CA_EMPTY = 0,                           /**< Empty */
 329     CA_CREATED = 201,                       /**< Created */
 330     CA_DELETED = 202,                       /**< Deleted */
 331     CA_VALID = 203,                         /**< Valid */
 332     CA_CHANGED = 204,                       /**< Changed */
 333     CA_CONTENT = 205,                       /**< Content */
 334     CA_CONTINUE = 231,                      /**< Continue */
 335     CA_BAD_REQ = 400,                       /**< Bad Request */
 336     CA_UNAUTHORIZED_REQ = 401,              /**< Unauthorized Request */
 337     CA_BAD_OPT = 402,                       /**< Bad Option */
 338     CA_FORBIDDEN_REQ = 403,                 /**< Forbidden Request */
 339     CA_NOT_FOUND = 404,                     /**< Not found */
 340     CA_METHOD_NOT_ALLOWED = 405,            /**< Method Not Allowed */
 341     CA_NOT_ACCEPTABLE = 406,                /**< Not Acceptable */
 342     CA_REQUEST_ENTITY_INCOMPLETE = 408,     /**< Request Entity Incomplete */
 343     CA_REQUEST_ENTITY_TOO_LARGE = 413,      /**< Request Entity Too Large */
 344     CA_INTERNAL_SERVER_ERROR = 500,         /**< Internal Server Error */
 345     CA_RETRANSMIT_TIMEOUT = 504             /**< Retransmit timeout */
 346     /* Response status code - END HERE */
 347 } CAResponseResult_t;
 348
 349 /**
 350  * @enum CATransportProtocolID_t
 351  * Transport Protocol IDs for additional options
 352  */
 353 typedef enum
 354 {
 355     CA_INVALID_ID = (1 << 0),   /**< Invalid ID */
 356     CA_COAP_ID = (1 << 1)       /**< COAP ID */
 357 } CATransportProtocolID_t;
 358
 359 /**
 360  * @enum CAAdapterState_t
 361  * Adapter State to indicate the network changed notifications.
 362  */
 363 typedef enum
 364 {
 365     CA_ADAPTER_DISABLED,   /**< Adapter is Disabled */
 366     CA_ADAPTER_ENABLED     /**< Adapter is Enabled */
 367 } CAAdapterState_t;
 368
 369 /**
 370  * Format indicating which encoding has been used on the payload.
 371  */
 372 typedef enum
 373 {
 374     CA_FORMAT_UNDEFINED = 0,            /**< Undefined enoding format */
 375     CA_FORMAT_TEXT_PLAIN,
 376     CA_FORMAT_APPLICATION_LINK_FORMAT,
 377     CA_FORMAT_APPLICATION_XML,
 378     CA_FORMAT_APPLICATION_OCTET_STREAM,
 379     CA_FORMAT_APPLICATION_RDF_XML,
 380     CA_FORMAT_APPLICATION_EXI,
 381     CA_FORMAT_APPLICATION_JSON,
 382     CA_FORMAT_APPLICATION_CBOR,
 383     CA_FORMAT_UNSUPPORTED
 384 } CAPayloadFormat_t;
 385
 386 /**
 387  * Header options structure to be filled
 388  *
 389  * This structure is used to hold header information.
 390  */
 391 typedef struct
 392 {
 393     CATransportProtocolID_t protocolID;                     /**< Protocol ID of the Option */
 394     uint16_t optionID;                                      /**< The header option ID which will be
 395                                                             added to communication packets */
 396     uint16_t optionLength;                                  /**< Option Length **/
 397     char optionData[CA_MAX_HEADER_OPTION_DATA_LENGTH];      /**< Optional data values**/
 398 } CAHeaderOption_t;
 399
 400 /**
 401  * Base Information received
 402  *
 403  * This structure is used to hold request & response base information
 404  */
 405 typedef struct
 406 {
 407     CAMessageType_t type;       /**< Qos for the request */
 408 #ifdef ROUTING_GATEWAY
 409     bool skipRetransmission;    /**< Will not attempt retransmission even if type is CONFIRM.
 410                                      Required for packet forwarding */
 411 #endif
 412     uint16_t messageId;         /**< Message id.
 413                                  * if message id is zero, it will generated by CA inside.
 414                                  * otherwise, you can use it */
 415     CAToken_t token;            /**< Token for CA */
 416     uint8_t tokenLength;        /**< token length */
 417     CAHeaderOption_t *options;  /** Header Options for the request */
 418     uint8_t numOptions;         /**< Number of Header options */
 419     CAPayload_t payload;        /**< payload of the request  */
 420     size_t payloadSize;         /**< size in bytes of the payload */
 421     CAPayloadFormat_t payloadFormat;    /**< encoding format of the request payload */
 422     CAPayloadFormat_t acceptFormat;     /**< accept format for the response payload */
 423     CAURI_t resourceUri;        /**< Resource URI information **/
 424     CARemoteId_t identity;      /**< endpoint identity */
 425 } CAInfo_t;
 426
 427 /**
 428  * Request Information to be sent
 429  *
 430  * This structure is used to hold request information
 431  */
 432 typedef struct
 433 {
 434     CAMethod_t method;  /**< Name of the Method Allowed */
 435     CAInfo_t info;      /**< Information of the request. */
 436     bool isMulticast;   /**< is multicast request */
 437 } CARequestInfo_t;
 438
 439 /**
 440  * Response information received
 441  *
 442  * This structure is used to hold response information
 443  */
 444 typedef struct
 445 {
 446     CAResponseResult_t result;  /**< Result for response by resource model */
 447     CAInfo_t info;              /**< Information of the response */
 448     bool isMulticast;
 449 } CAResponseInfo_t;
 450
 451 /**
 452  * Error information from CA
 453  *        contains error code and message information
 454  *
 455  * This structure holds error information
 456  */
 457 typedef struct
 458 {
 459     CAResult_t result;  /**< CA API request result  */
 460     CAInfo_t info;      /**< message information such as token and payload data
 461                              helpful to identify the error */
 462 } CAErrorInfo_t;
 463
 464 /**
 465  * Hold global variables for CA layer (also used by RI layer)
 466  */
 467 typedef struct
 468 {
 469     CASocketFd_t fd;    /**< socket fd */
 470     uint16_t port;      /**< socket port */
 471 } CASocket_t;
 472
 473 #define HISTORYSIZE (4)
 474
 475 typedef struct
 476 {
 477     CATransportFlags_t flags;
 478     uint16_t messageId;
 479     char token[CA_MAX_TOKEN_LEN];
 480     uint8_t tokenLength;
 481 } CAHistoryItem_t;
 482
 483 typedef struct
 484 {
 485     int nextIndex;
 486     CAHistoryItem_t items[HISTORYSIZE];
 487 } CAHistory_t;
 488
 489 /**
 490  * Hold interface index for keeping track of comings and goings
 491  */
 492 typedef struct
 493 {
 494     int32_t ifIndex; /**< network interface index */
 495 } CAIfItem_t;
 496
 497 /**
 498  * Hold the port number assigned from application.
 499  * It will be used when creating a socket.
 500  */
 501 typedef struct
 502 {
 503     struct udpports
 504     {
 505         uint16_t u6;    /**< unicast IPv6 socket port */
 506         uint16_t u6s;   /**< unicast IPv6 socket secure port */
 507         uint16_t u4;    /**< unicast IPv4 socket port */
 508         uint16_t u4s;   /**< unicast IPv4 socket secure port */
 509     } udp;
 510 #ifdef TCP_ADAPTER
 511     struct tcpports
 512     {
 513         uint16_t u4;    /**< unicast IPv4 socket port */
 514         uint16_t u6;    /**< unicast IPv6 socket port */
 515     } tcp;
 516 #endif
 517 } CAPorts_t;
 518
 519 typedef struct
 520 {
 521     CATransportFlags_t clientFlags; /**< flag for client */
 522     CATransportFlags_t serverFlags; /**< flag for server */
 523     bool client; /**< client mode */
 524     bool server; /**< server mode */
 525
 526     CAPorts_t ports;
 527
 528     struct sockets
 529     {
 530         void *threadpool;           /**< threadpool between Initialize and Start */
 531         CASocket_t u6;              /**< unicast   IPv6 */
 532         CASocket_t u6s;             /**< unicast   IPv6 secure */
 533         CASocket_t u4;              /**< unicast   IPv4 */
 534         CASocket_t u4s;             /**< unicast   IPv4 secure */
 535         CASocket_t m6;              /**< multicast IPv6 */
 536         CASocket_t m6s;             /**< multicast IPv6 secure */
 537         CASocket_t m4;              /**< multicast IPv4 */
 538         CASocket_t m4s;             /**< multicast IPv4 secure */
 539         CASocketFd_t netlinkFd;     /**< netlink */
 540 #if defined(_WIN32)
 541         WSAEVENT shutdownEvent;     /**< Event used to signal threads to stop */
 542 #else
 543         int shutdownFds[2];         /**< fds used to signal threads to stop */
 544 #endif
 545         int selectTimeout;          /**< in seconds */
 546         int maxfd;                  /**< highest fd (for select) */
 547         bool started;               /**< the IP adapter has started */
 548         bool terminate;             /**< the IP adapter needs to stop */
 549         bool ipv6enabled;           /**< IPv6 enabled by OCInit flags */
 550         bool ipv4enabled;           /**< IPv4 enabled by OCInit flags */
 551         bool dualstack;             /**< IPv6 and IPv4 enabled */
 552 #if defined (_WIN32)
 553         LPFN_WSARECVMSG wsaRecvMsg; /**< Win32 function pointer to WSARecvMsg() */
 554 #endif
 555
 556         struct networkmonitors
 557         {
 558             CAIfItem_t *ifItems; /**< current network interface index list */
 559             size_t sizeIfItems;  /**< size of network interface index array */
 560             size_t numIfItems;   /**< number of valid network interfaces */
 561         } nm;
 562     } ip;
 563
 564     struct calayer
 565     {
 566         CAHistory_t requestHistory;  /**< filter IP family in requests */
 567     } ca;
 568
 569 #ifdef TCP_ADAPTER
 570     /**
 571      * Hold global variables for TCP Adapter.
 572      */
 573     struct tcpsockets
 574     {
 575         void *threadpool;       /**< threadpool between Initialize and Start */
 576         CASocket_t ipv4;        /**< IPv4 accept socket */
 577         CASocket_t ipv6;        /**< IPv6 accept socket */
 578         void *svrlist;          /**< unicast IPv4 TCP server information*/
 579         int selectTimeout;      /**< in seconds */
 580         int listenBacklog;      /**< backlog counts*/
 581         int shutdownFds[2];     /**< shutdown pipe */
 582         int connectionFds[2];   /**< connection pipe */
 583         int maxfd;              /**< highest fd (for select) */
 584         bool started;           /**< the TCP adapter has started */
 585         bool terminate;         /**< the TCP adapter needs to stop */
 586         bool ipv4tcpenabled;    /**< IPv4 TCP enabled by OCInit flags */
 587         bool ipv6tcpenabled;    /**< IPv6 TCP enabled by OCInit flags */
 588     } tcp;
 589 #endif
 590 } CAGlobals_t;
 591
 592 extern CAGlobals_t caglobals;
 593
 594 /**
 595  * Callback function type for request delivery.
 596  * @param[out]   object       Endpoint object from which the request is received.
 597  *                            It contains endpoint address based on the connectivity type.
 598  * @param[out]   requestInfo  Info for resource model to understand about the request.
 599  */
 600 typedef void (*CARequestCallback)(const CAEndpoint_t *object,
 601                                   const CARequestInfo_t *requestInfo);
 602
 603 /**
 604  * Callback function type for response delivery.
 605  * @param[out]   object           Endpoint object from which the response is received.
 606  * @param[out]   responseInfo     Identifier which needs to be mapped with response.
 607  */
 608 typedef void (*CAResponseCallback)(const CAEndpoint_t *object,
 609                                    const CAResponseInfo_t *responseInfo);
 610 /**
 611  * Callback function type for error.
 612  * @param[out]   object           remote device information.
 613  * @param[out]   errorInfo        CA Error information.
 614  */
 615 typedef void (*CAErrorCallback)(const CAEndpoint_t *object,
 616                                 const CAErrorInfo_t *errorInfo);
 617
 618 /**
 619  * Callback function type for network status changes delivery from CA common logic.
 620  * @param[out]   info       Endpoint object from which the network status is changed.
 621  *                          It contains endpoint address based on the connectivity type.
 622  * @param[out]   status     Current network status info.
 623  */
 624 typedef void (*CANetworkMonitorCallback)(const CAEndpoint_t *info, CANetworkStatus_t status);
 625
 626 #ifdef __cplusplus
 627 } /* extern "C" */
 628 #endif
 629
 630 #endif // CA_COMMON_H_