-/******************************************************************
+/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
/**
* @file cacommon.h
- * @brief This file contains the common data structures between Resource , CA and adapters
+ * This file contains the common data structures between Resource , CA and adapters
*/
-#ifndef __CA_COMMON_H_
-#define __CA_COMMON_H_
+#ifndef CA_COMMON_H_
+#define CA_COMMON_H_
+
+#include "iotivity_config.h"
+#ifdef WITH_PROCESS_EVENT
+#include "ocevent.h"
+#endif
+
+#ifndef WITH_ARDUINO
+#ifdef TCP_ADAPTER
+#define HAVE_SYS_POLL_H
+#endif
+#endif
#include <stdint.h>
#include <stdlib.h>
+#include <stdbool.h>
+
+#ifdef __TIZENRT__
+#include <poll.h>
+#else
+#ifdef HAVE_SYS_POLL_H
+#include <sys/poll.h>
+#endif
+#endif
+
+#ifdef HAVE_WINSOCK2_H
+#include <winsock2.h>
+#include <mswsock.h>
+#endif
#ifdef __cplusplus
extern "C"
#endif
/**
- @brief IP address Length
+ * TAG of Analyzer log.
+ */
+#define ANALYZER_TAG "OIC_CA_ANALYZER_102301"
+#define BLE_CLIENT_TAG "OIC_CA_LE_CLIENT_1023"
+#define BLE_SERVER_MCD_TAG "OIC_CA_LE_SER_MC_1023"
+#define IP_SERVER_TAG "OIC_CA_IP_SERVER_1023"
+#define TCP_SERVER_TAG "OIC_CA_TCP_SERVER_1023"
+
+/**
+ * IP address Length.
*/
#define CA_IPADDR_SIZE 16
/**
- @brief Mac address length for BT port
+ * Remote Access jabber ID length.
*/
-#define CA_MACADDR_SIZE 18
+#define CA_RAJABBERID_SIZE 256
/**
- @brief Max header options data length
+ * Mac address length for BT port.
*/
-#define CA_MAX_HEADER_OPTION_DATA_LENGTH 16
+#define CA_MACADDR_SIZE 18
/**
- @brief Max URI length
+ * Max header options data length.
*/
-#define CA_MAX_URI_LENGTH 128
+#if defined(ARDUINO) || defined(__TIZENRT__)
+#define CA_MAX_HEADER_OPTION_DATA_LENGTH 20
+#else
+#define CA_MAX_HEADER_OPTION_DATA_LENGTH 1024
+#endif
/**
-@brief option types - the highest option number 63
+* Max token length.
*/
+#define CA_MAX_TOKEN_LEN (8)
+
+/**
+* Max interface name length.
+*/
+#define CA_MAX_INTERFACE_NAME_LEN (16)
+
+/**
+ * Max URI length.
+ */
+#ifdef ARDUINO
+#define CA_MAX_URI_LENGTH 128 /* maximum size of URI for embedded platforms*/
+#else
+#define CA_MAX_URI_LENGTH 512 /* maximum size of URI for other platforms*/
+#endif
+
+/**
+ * Max PDU length supported.
+ */
+#ifdef ARDUINO
+#define COAP_MAX_PDU_SIZE 320 /* maximum size of a CoAP PDU for embedded platforms*/
+#else
+#define COAP_MAX_PDU_SIZE 1400 /* maximum size of a CoAP PDU for big platforms*/
+#endif
+
+#ifdef WITH_BWT
+#define CA_DEFAULT_BLOCK_SIZE CA_BLOCK_SIZE_1024_BYTE
+#endif
+
+/**
+ *Maximum length of the remoteEndpoint identity.
+ */
+#define CA_MAX_ENDPOINT_IDENTITY_LEN CA_MAX_IDENTITY_SIZE
+
+/**
+ * Max identity size.
+ */
+#define CA_MAX_IDENTITY_SIZE (37)
+
+/**
+ * option types - the highest option number 63.
+ */
#define CA_OPTION_IF_MATCH 1
#define CA_OPTION_ETAG 4
#define CA_OPTION_IF_NONE_MATCH 5
+#define CA_OPTION_OBSERVE 6
#define CA_OPTION_LOCATION_PATH 8
#define CA_OPTION_URI_PATH 11
#define CA_OPTION_CONTENT_FORMAT 12
#define CA_OPTION_URI_QUERY 15
#define CA_OPTION_ACCEPT 17
#define CA_OPTION_LOCATION_QUERY 20
-#define CA_OPTION_OBSERVE 6
/**
- @brief Max length of ID
+ * Payload information from resource model.
*/
-#define DTLS_PSK_ID_LEN 16
+typedef uint8_t *CAPayload_t;
/**
- @brief Max length of PSK
+ * URI for the OIC base.CA considers relative URI as the URI.
*/
-#define DTLS_PSK_PSK_LEN 16
+typedef char *CAURI_t;
/**
- @brief version
+ * Token information for mapping the request and responses by resource model.
*/
-#define DtlsPskCredsBlobVer_1 1
+typedef char *CAToken_t;
-/**
- @brief current version
+/*
+ * Socket types and error definitions.
*/
-#define DtlsPskCredsBlobVer_CurrentVersion DtlsPskCredsBlobVer_1
-
+#ifdef HAVE_WINSOCK2_H
+# define OC_SOCKET_ERROR SOCKET_ERROR
+# define OC_INVALID_SOCKET INVALID_SOCKET
+typedef SOCKET CASocketFd_t;
+#else // HAVE_WINSOCK2_H
+# define OC_SOCKET_ERROR (-1)
+# define OC_INVALID_SOCKET (-1)
+typedef int CASocketFd_t;
+#endif
-/**
- @brief Payload information from resource model
+/*
+ * The following flags are the same as the equivalent OIC values in
+ * octypes.h, allowing direct copying with slight fixup.
+ * The CA layer should used the OC types when build allows that.
*/
-typedef char *CAPayload_t;
-
-/**
- @brief URI for the OIC base.CA considers relative URI as the URI.
+#ifdef RA_ADAPTER
+#define MAX_ADDR_STR_SIZE_CA (256)
+#else
+/*
+ * Max Address could be "coaps+tcp://[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:yyy.yyy.yyy.yyy]:xxxxx"
+ * Which is 65, +1 for null terminator => 66
+ * OCDevAddr (defined in OCTypes.h) must be the same
+ * as CAEndpoint_t (defined here)
*/
-typedef char *CAURI_t;
+#define MAX_ADDR_STR_SIZE_CA (66)
+#endif
-/**
- @brief Token information for mapping the request and responses by resource model
- */
-typedef char *CAToken_t;
+typedef enum
+{
+ CA_DEFAULT_ADAPTER = 0,
-/**
- @brief Boolean value used for specifying the success or failure
- */
+ // value zero indicates discovery
+ CA_ADAPTER_IP = (1 << 0), // IPv4 and IPv6, including 6LoWPAN
+ CA_ADAPTER_GATT_BTLE = (1 << 1), // GATT over Bluetooth LE
+ CA_ADAPTER_RFCOMM_BTEDR = (1 << 2), // RFCOMM over Bluetooth EDR
+
+#ifdef RA_ADAPTER
+ CA_ADAPTER_REMOTE_ACCESS = (1 << 3), // Remote Access over XMPP.
+#endif
+
+ CA_ADAPTER_TCP = (1 << 4), // CoAP over TCP
+ CA_ADAPTER_NFC = (1 << 5), // NFC Adapter
+
+ CA_ALL_ADAPTERS = 0xffffffff
+} CATransportAdapter_t;
typedef enum
{
- CA_FALSE = 0,
- CA_TRUE
-} CABool_t;
+ CA_DEFAULT_FLAGS = 0,
+
+ // Insecure transport is the default (subject to change)
+ CA_SECURE = (1 << 4), // secure the transport path
+ // IPv4 & IPv6 autoselection is the default
+ CA_IPV6 = (1 << 5), // IP adapter only
+ CA_IPV4 = (1 << 6), // IP adapter only
+ // Indication that a message was received by multicast.
+ CA_MULTICAST = (1 << 7),
+ // Link-Local multicast is the default multicast scope for IPv6.
+ // These correspond in both value and position to the IPv6 address bits.
+ CA_SCOPE_INTERFACE = 0x1, // IPv6 Interface-Local scope
+ CA_SCOPE_LINK = 0x2, // IPv6 Link-Local scope (default)
+ CA_SCOPE_REALM = 0x3, // IPv6 Realm-Local scope
+ CA_SCOPE_ADMIN = 0x4, // IPv6 Admin-Local scope
+ CA_SCOPE_SITE = 0x5, // IPv6 Site-Local scope
+ CA_SCOPE_ORG = 0x8, // IPv6 Organization-Local scope
+ CA_SCOPE_GLOBAL = 0xE, // IPv6 Global scope
+} CATransportFlags_t;
-/**
- @brief Different connectivities that are handled in Connectivity Abstraction
- */
typedef enum
{
- CA_ETHERNET = (1 << 0),
- CA_WIFI = (1 << 1),
- CA_EDR = (1 << 2),
- CA_LE = (1 << 3)
-} CAConnectivityType_t;
+ CA_DEFAULT_BT_FLAGS = 0,
+ // flags for BLE transport
+ CA_LE_ADV_DISABLE = 0x1, // disable BLE advertisement.
+ CA_LE_ADV_ENABLE = 0x2, // enable BLE advertisement.
+ CA_LE_SERVER_DISABLE = (1 << 4), // disable gatt server.
+ // flags for EDR transport
+ CA_EDR_SERVER_DISABLE = (1 << 7) // disable rfcomm server.
+} CATransportBTFlags_t;
+
+#define CA_IPFAMILY_MASK (CA_IPV6|CA_IPV4)
+#define CA_SCOPE_MASK 0xf // mask scope bits above
/**
- @brief Information about the network status.CA_INTERFACE_UP means connectivity is available
+ * Information about the network status.
*/
typedef enum
{
- CA_INTERFACE_UP,
- CA_INTERFACE_DOWN
+ CA_INTERFACE_DOWN, /**< Connection is not available */
+ CA_INTERFACE_UP /**< Connection is Available */
} CANetworkStatus_t;
-/**
- @brief Address of the local or remote endpoint
+/*
+ * remoteEndpoint identity.
*/
-typedef union
+typedef struct
{
- /**
- @brief BT Mac Information
- */
- struct
- {
- /** @brief BT mac address **/
- char btMacAddress[CA_MACADDR_SIZE];
- } BT;
-
- /**
- @brief LE MAC Information
- */
- struct
- {
- /** @brief BLE mac address **/
- char leMacAddress[CA_MACADDR_SIZE];
- } LE;
-
- /**
- @brief IP Information for wifi and ethernet ports
- */
- struct
- {
- /** Ip address of the interface**/
- char ipAddress[CA_IPADDR_SIZE];
- /** port information**/
- uint32_t port;
- } IP;
-} CAAddress_t;
+ uint16_t id_length;
+ unsigned char id[CA_MAX_ENDPOINT_IDENTITY_LEN];
+} CARemoteId_t;
/**
- @brief Message Type for Base source code
+ * Message Type for Base source code.
*/
typedef enum
{
- CA_MSG_CONFIRM = 0, /* confirmable message (requires ACK/RST) */
- CA_MSG_NONCONFIRM, /* non-confirmable message (one-shot message) */
- CA_MSG_ACKNOWLEDGE, /* used to acknowledge confirmable messages */
- CA_MSG_RESET /* indicates error in received messages */
+ CA_MSG_CONFIRM = 0, /**< confirmable message (requires ACK/RST) */
+ CA_MSG_NONCONFIRM, /**< non-confirmable message (one-shot message) */
+ CA_MSG_ACKNOWLEDGE, /**< used to acknowledge confirmable messages */
+ CA_MSG_RESET /**< used to indicates not-interested or error (lack of context)in
+ received messages */
} CAMessageType_t;
/**
- @brief Allowed method to be used by resource model
+ * Allowed method to be used by resource model.
*/
typedef enum
{
- CA_GET = 1,
- CA_POST,
- CA_PUT,
- CA_DELETE
+ CA_GET = 1, /**< GET Method */
+ CA_POST, /**< POST Method */
+ CA_PUT, /**< PUT Method */
+ CA_DELETE /**< DELETE Method */
} CAMethod_t;
/**
- @brief Remote endpoint information for connectivities
+ * block size.
+ * it depends on defined size in libCoAP.
*/
-typedef struct
+typedef enum
{
- /** Resource URI information **/
- CAURI_t resourceUri;
- /** Remote Endpoint address **/
- CAAddress_t addressInfo;
- /** Connectivity of the endpoint**/
- CAConnectivityType_t connectivityType;
- /** Secure connection**/
- CABool_t isSecured;
-} CARemoteEndpoint_t;
-
+ CA_BLOCK_SIZE_16_BYTE = 0, /**< 16byte */
+ CA_BLOCK_SIZE_32_BYTE = 1, /**< 32byte */
+ CA_BLOCK_SIZE_64_BYTE = 2, /**< 64byte */
+ CA_BLOCK_SIZE_128_BYTE = 3, /**< 128byte */
+ CA_BLOCK_SIZE_256_BYTE = 4, /**< 256byte */
+ CA_BLOCK_SIZE_512_BYTE = 5, /**< 512byte */
+ CA_BLOCK_SIZE_1024_BYTE = 6 /**< 1Kbyte */
+} CABlockSize_t;
/**
- @brief Group endpoint information for connectivities
+ * Endpoint information for connectivities.
+ * Must be identical to OCDevAddr.
*/
typedef struct
{
- /** Resource URI information **/
- CAURI_t resourceUri;
- /** Connectivity of the endpoint**/
- CAConnectivityType_t connectivityType;
-} CAGroupEndpoint_t;
+ CATransportAdapter_t adapter; // adapter type
+ CATransportFlags_t flags; // transport modifiers
+ uint16_t port; // for IP
+ char addr[MAX_ADDR_STR_SIZE_CA]; // address for all
+ uint32_t ifindex; // usually zero for default interface
+ char remoteId[CA_MAX_IDENTITY_SIZE]; // device ID of remote device
+#if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
+ char routeData[MAX_ADDR_STR_SIZE_CA]; /**< GatewayId:ClientId of
+ destination. **/
+#endif
+} CAEndpoint_t;
/**
- @brief Local Connectivity information
+ * Endpoint information for secure messages.
*/
typedef struct
{
- /** address of the interface **/
- CAAddress_t addressInfo;
- /** Connectivity type that localconnectivity avaialble **/
- CAConnectivityType_t type;
- /** Secure connection**/
- CABool_t isSecured;
-} CALocalConnectivity_t;
+ CAEndpoint_t endpoint; /**< endpoint */
+ // TODO change name to deviceId
+ CARemoteId_t identity; /**< endpoint device uuid */
+ CARemoteId_t userId; /**< endpoint user uuid */
+} CASecureEndpoint_t;
/**
- @brief Enums for CA return values
+ * Enums for CA return values.
*/
typedef enum
{
- /* Success status code - START HERE */
- CA_STATUS_OK = 0,
- CA_STATUS_INVALID_PARAM,
- CA_ADAPTER_NOT_ENABLED,
- CA_SERVER_STARTED_ALREADY,
- CA_SERVER_NOT_STARTED,
- CA_DESTINATION_NOT_REACHABLE,
- CA_SOCKET_OPERATION_FAILED,
- CA_SEND_FAILED,
- CA_RECEVIE_FAILED,
- CA_MEMORY_ALLOC_FAILED,
- CA_REQUEST_TIMEOUT,
- CA_DESTINATION_DISCONNECTED,
- CA_STATUS_FAILED,
- CA_NOT_SUPPORTED
+ /* Result code - START HERE */
+ CA_STATUS_OK = 0, /**< Success */
+ CA_STATUS_INVALID_PARAM, /**< Invalid Parameter */
+ CA_ADAPTER_NOT_ENABLED, /**< Adapter is not enabled */
+ CA_SERVER_STARTED_ALREADY, /**< Server is started already */
+ CA_SERVER_NOT_STARTED, /**< Server is not started */
+ CA_DESTINATION_NOT_REACHABLE, /**< Destination is not reachable */
+ CA_SOCKET_OPERATION_FAILED, /**< Socket operation failed */
+ CA_SEND_FAILED, /**< Send request failed */
+ CA_RECEIVE_FAILED, /**< Receive failed */
+ CA_MEMORY_ALLOC_FAILED, /**< Memory allocation failed */
+ CA_REQUEST_TIMEOUT, /**< Request is Timeout */
+ CA_DESTINATION_DISCONNECTED, /**< Destination is disconnected */
+ CA_NOT_SUPPORTED, /**< Not supported */
+ CA_STATUS_NOT_INITIALIZED, /**< Not Initialized*/
+ CA_DTLS_AUTHENTICATION_FAILURE, /**< Decryption error in DTLS */
+ CA_STATUS_FAILED =255 /**< Failure */
/* Result code - END HERE */
} CAResult_t;
/**
- @brief Enums for CA Response values
+ * Enums for CA Response values.
*/
typedef enum
{
- /* Success status code - START HERE */
- CA_SUCCESS = 200,
- CA_CREATED = 201,
- CA_DELETED = 202,
- CA_BAD_REQ = 400,
- CA_BAD_OPT = 402,
- CA_NOT_FOUND = 404
- /* Response status code - END HERE */
+ /* Response status code - START HERE */
+ CA_EMPTY = 0, /**< Empty */
+ CA_CREATED = 201, /**< Created */
+ CA_DELETED = 202, /**< Deleted */
+ CA_VALID = 203, /**< Valid */
+ CA_CHANGED = 204, /**< Changed */
+ CA_CONTENT = 205, /**< Content */
+ CA_CONTINUE = 231, /**< Continue */
+ CA_BAD_REQ = 400, /**< Bad Request */
+ CA_UNAUTHORIZED_REQ = 401, /**< Unauthorized Request */
+ CA_BAD_OPT = 402, /**< Bad Option */
+ CA_FORBIDDEN_REQ = 403, /**< Forbidden Request */
+ CA_NOT_FOUND = 404, /**< Not found */
+ CA_METHOD_NOT_ALLOWED = 405, /**< Method Not Allowed */
+ CA_NOT_ACCEPTABLE = 406, /**< Not Acceptable */
+ CA_REQUEST_ENTITY_INCOMPLETE = 408, /**< Request Entity Incomplete */
+ CA_REQUEST_ENTITY_TOO_LARGE = 413, /**< Request Entity Too Large */
+ CA_TOO_MANY_REQUESTS = 429, /**< Too Many Requests */
+ CA_INTERNAL_SERVER_ERROR = 500, /**< Internal Server Error */
+ CA_NOT_IMPLEMENTED = 501, /**< Not Implenented */
+ CA_BAD_GATEWAY = 502, /**< Bad Gateway */
+ CA_SERVICE_UNAVAILABLE = 503, /**< Server Unavailable */
+ CA_RETRANSMIT_TIMEOUT = 504, /**< Retransmit timeout */
+ CA_PROXY_NOT_SUPPORTED = 505 /**< Proxy not enabled to service a request */
+ /* Response status code - END HERE */
} CAResponseResult_t;
/**
- @brief Transport Protocol IDs for additional options
+ * Data type whether the data is Request Message or Response Message.
+ * if there is some failure before send data on network.
+ * Type will be set as error type for error callback.
+ */
+typedef enum
+{
+ CA_REQUEST_DATA = 1,
+ CA_RESPONSE_DATA,
+ CA_ERROR_DATA,
+ CA_RESPONSE_FOR_RES,
+ CA_NETWORK_COMMAND,
+ CA_REQUEST_DATA_SERVER_INIT,
+ CA_RESPONSE_DATA_CLIENT_INIT
+} CADataType_t;
+
+typedef enum
+{
+ CA_DISCONNECTED = 0,
+ CA_CONNECTED,
+ CA_REQ_DISCONNECT
+} CAConnectEvent_t;
+
+/**
+ * Transport Protocol IDs for additional options.
*/
typedef enum
{
- CA_INVALID_ID = (1 << 0),
- CA_COAP_ID = (1 << 1)
+ CA_INVALID_ID = (1 << 0), /**< Invalid ID */
+ CA_COAP_ID = (1 << 1) /**< COAP ID */
} CATransportProtocolID_t;
/**
- * @brief Header options structure to be filled
+ * Adapter State to indicate the network changed notifications.
+ */
+typedef enum
+{
+ CA_ADAPTER_DISABLED, /**< Adapter is Disabled */
+ CA_ADAPTER_ENABLED /**< Adapter is Enabled */
+} CAAdapterState_t;
+
+/**
+ * Format indicating which encoding has been used on the payload.
+ */
+typedef enum
+{
+ CA_FORMAT_UNDEFINED = 0, /**< Undefined enoding format */
+ CA_FORMAT_TEXT_PLAIN,
+ CA_FORMAT_APPLICATION_LINK_FORMAT,
+ CA_FORMAT_APPLICATION_XML,
+ CA_FORMAT_APPLICATION_OCTET_STREAM,
+ CA_FORMAT_APPLICATION_RDF_XML,
+ CA_FORMAT_APPLICATION_EXI,
+ CA_FORMAT_APPLICATION_JSON,
+ CA_FORMAT_APPLICATION_CBOR,
+ CA_FORMAT_UNSUPPORTED
+} CAPayloadFormat_t;
+
+/**
+ * Header options structure to be filled.
*
* This structure is used to hold header information.
*/
typedef struct
{
- /** The protocol ID this option applies to**/
- CATransportProtocolID_t protocolID;
- /** The header option ID which will be added to communication packets**/
- uint16_t optionID;
- /** its length **/
- uint16_t optionLength;
- /** optional data values**/
- uint8_t optionData[CA_MAX_HEADER_OPTION_DATA_LENGTH];
+ CATransportProtocolID_t protocolID; /**< Protocol ID of the Option */
+ uint16_t optionID; /**< The header option ID which will be
+ added to communication packets */
+ uint16_t optionLength; /**< Option Length **/
+ char optionData[CA_MAX_HEADER_OPTION_DATA_LENGTH]; /**< Optional data values**/
} CAHeaderOption_t;
/**
- * @brief Base Information received
+ * Base Information received.
*
- * This structure is used to hold request & response base information
+ * This structure is used to hold request & response base information.
*/
typedef struct
{
- /**Qos for the request **/
- CAMessageType_t type;
- /** Message id.
- * if message id is zero, it will generated by CA inside.
- * otherwise, you can use it.**/
- uint16_t messageId;
- /** Token for CA**/
- CAToken_t token;
- /** Header Options for the request **/
- CAHeaderOption_t *options;
- /** Number of Header options**/
- uint8_t numOptions;
- /** payload of the request **/
- CAPayload_t payload;
+ CAMessageType_t type; /**< Qos for the request */
+#ifdef ROUTING_GATEWAY
+ bool skipRetransmission; /**< Will not attempt retransmission even if type is CONFIRM.
+ Required for packet forwarding */
+#endif
+ uint16_t messageId; /**< Message id.
+ * if message id is zero, it will generated by CA inside.
+ * otherwise, you can use it */
+ CAToken_t token; /**< Token for CA */
+ uint8_t tokenLength; /**< token length */
+ CAHeaderOption_t *options; /** Header Options for the request */
+ uint8_t numOptions; /**< Number of Header options */
+ CAPayload_t payload; /**< payload of the request */
+ size_t payloadSize; /**< size in bytes of the payload */
+ CAPayloadFormat_t payloadFormat; /**< encoding format of the request payload */
+ CAPayloadFormat_t acceptFormat; /**< accept format for the response payload */
+ CAURI_t resourceUri; /**< Resource URI information **/
+ CARemoteId_t identity; /**< endpoint identity */
+ CADataType_t dataType; /**< data type */
+ CAConnectEvent_t event; /**< network request message / event type */
} CAInfo_t;
/**
- * @brief Request Information to be sent
+ * Request Information to be sent.
*
- * This structure is used to hold request information
+ * This structure is used to hold request information.
*/
typedef struct
{
- /** Name of the Method Allowed **/
- CAMethod_t method;
- /** Information of the request. **/
- CAInfo_t info;
+ CAMethod_t method; /**< Name of the Method Allowed */
+ CAInfo_t info; /**< Information of the request. */
+ bool isMulticast; /**< is multicast request */
} CARequestInfo_t;
/**
- * @brief Response information received
+ * Response information received.
*
- * This structure is used to hold response information
+ * This structure is used to hold response information.
*/
typedef struct
{
- /**Result for response by resource model**/
- CAResponseResult_t result;
- /**Information of the response.**/
- CAInfo_t info;
+ CAResponseResult_t result; /**< Result for response by resource model */
+ CAInfo_t info; /**< Information of the response */
+ bool isMulticast;
} CAResponseInfo_t;
/**
- * Credentials for a device. Includes identity and the associated PSK.
+ * Error information from CA
+ * contains error code and message information.
+ *
+ * This structure holds error information.
+ */
+typedef struct
+{
+ CAResult_t result; /**< CA API request result */
+ CAInfo_t info; /**< message information such as token and payload data
+ helpful to identify the error */
+} CAErrorInfo_t;
+
+/**
+ * Hold global variables for CA layer. (also used by RI layer)
+ */
+typedef struct
+{
+ CASocketFd_t fd; /**< socket fd */
+ uint16_t port; /**< socket port */
+} CASocket_t;
+
+#define HISTORYSIZE (4)
+
+typedef struct
+{
+ CATransportFlags_t flags;
+ uint16_t messageId;
+ char token[CA_MAX_TOKEN_LEN];
+ uint8_t tokenLength;
+} CAHistoryItem_t;
+
+typedef struct
+{
+ int nextIndex;
+ CAHistoryItem_t items[HISTORYSIZE];
+} CAHistory_t;
+
+/**
+ * Hold interface index for keeping track of comings and goings.
*/
typedef struct
{
- unsigned char clientIdentity[DTLS_PSK_ID_LEN];
- unsigned char rsClientPsk[DTLS_PSK_PSK_LEN];
-} CADtlsPskCreds_t;
+ int32_t ifIndex; /**< network interface index */
+} CAIfItem_t;
/**
- * Binary blob containing device identity and the credentials for all devices
- * trusted by this device.
+ * Hold the port number assigned from application.
+ * It will be used when creating a socket.
*/
typedef struct
{
- uint16_t blobVer; /**< version of the blob */
- uint16_t reserved; /**< reserved for future use */
- unsigned char rsIdentity[DTLS_PSK_ID_LEN]; /**< identity of self */
- uint32_t num; /**< number of credentials in this blob */
- CADtlsPskCreds_t *creds; /**< list of credentials. Size of this
- array is determined by 'num' variable. */
-} CADtlsPskCredsBlob_t;
+ struct udpports
+ {
+ uint16_t u6; /**< unicast IPv6 socket port */
+ uint16_t u6s; /**< unicast IPv6 socket secure port */
+ uint16_t u4; /**< unicast IPv4 socket port */
+ uint16_t u4s; /**< unicast IPv4 socket secure port */
+ } udp;
+#ifdef TCP_ADAPTER
+ struct tcpports
+ {
+ uint16_t u4; /**< unicast IPv4 socket port */
+ uint16_t u4s; /**< unicast IPv6 socket secure port */
+ uint16_t u6; /**< unicast IPv6 socket port */
+ uint16_t u6s; /**< unicast IPv6 socket secure port */
+ } tcp;
+#endif
+} CAPorts_t;
+
+typedef struct
+{
+ CATransportFlags_t clientFlags; /**< flag for client */
+ CATransportFlags_t serverFlags; /**< flag for server */
+ bool client; /**< client mode */
+ bool server; /**< server mode */
+
+ CAPorts_t ports;
+
+ struct sockets
+ {
+ void *threadpool; /**< threadpool between Initialize and Start */
+ CASocket_t u6; /**< unicast IPv6 */
+ CASocket_t u6s; /**< unicast IPv6 secure */
+ CASocket_t u4; /**< unicast IPv4 */
+ CASocket_t u4s; /**< unicast IPv4 secure */
+ CASocket_t m6; /**< multicast IPv6 */
+ CASocket_t m6s; /**< multicast IPv6 secure */
+ CASocket_t m4; /**< multicast IPv4 */
+ CASocket_t m4s; /**< multicast IPv4 secure */
+ CASocketFd_t netlinkFd; /**< netlink */
+#if defined(_WIN32)
+ WSAEVENT shutdownEvent; /**< Event used to signal threads to stop */
+#else
+#ifndef __TIZENRT__
+ int shutdownFds[2]; /**< fds used to signal threads to stop */
+#endif
+#endif
+ int selectTimeout; /**< in seconds */
+ bool started; /**< the IP adapter has started */
+ bool terminate; /**< the IP adapter needs to stop */
+ bool ipv6enabled; /**< IPv6 enabled by OCInit flags */
+ bool ipv4enabled; /**< IPv4 enabled by OCInit flags */
+ bool dualstack; /**< IPv6 and IPv4 enabled */
+#if defined (_WIN32)
+ LPFN_WSARECVMSG wsaRecvMsg; /**< Win32 function pointer to WSARecvMsg() */
+#endif
+
+ struct networkmonitors
+ {
+ CAIfItem_t *ifItems; /**< current network interface index list */
+ size_t sizeIfItems; /**< size of network interface index array */
+ size_t numIfItems; /**< number of valid network interfaces */
+ } nm;
+ } ip;
+
+ struct calayer
+ {
+ CAHistory_t requestHistory; /**< filter IP family in requests */
+ } ca;
+
+#ifdef TCP_ADAPTER
+ /**
+ * Hold global variables for TCP Adapter.
+ */
+ struct tcpsockets
+ {
+ void *threadpool; /**< threadpool between Initialize and Start */
+ CASocket_t ipv4; /**< IPv4 accept socket */
+ CASocket_t ipv4s; /**< IPv4 accept socket secure */
+ CASocket_t ipv6; /**< IPv6 accept socket */
+ CASocket_t ipv6s; /**< IPv6 accept socket secure */
+ void *svrlist; /**< unicast IPv4 TCP server information*/
+ int selectTimeout; /**< in seconds */
+ int listenBacklog; /**< backlog counts*/
+#ifndef __TIZENRT__
+ int shutdownFds[2]; /**< shutdown pipe */
+#endif
+ int connectionFds[2]; /**< connection pipe */
+ bool started; /**< the TCP adapter has started */
+ bool terminate; /**< the TCP adapter needs to stop */
+ bool bindenabled; /**< binding of TCP socket enabled */
+ bool ipv4tcpenabled; /**< IPv4 TCP enabled by OCInit flags */
+ bool ipv6tcpenabled; /**< IPv6 TCP enabled by OCInit flags */
+ } tcp;
+#endif
+ CATransportBTFlags_t bleFlags;
+} CAGlobals_t;
+
+extern CAGlobals_t caglobals;
+
+typedef enum
+{
+ CA_LOG_LEVEL_ALL = 1, // all logs.
+ CA_LOG_LEVEL_INFO, // debug level is disabled
+} CAUtilLogLevel_t;
+
+/**
+ * Callback function type for request delivery.
+ * @param[out] object Endpoint object from which the request is received.
+ * It contains endpoint address based on the connectivity type.
+ * @param[out] requestInfo Info for resource model to understand about the request.
+ */
+typedef void (*CARequestCallback)(const CAEndpoint_t *object,
+ const CARequestInfo_t *requestInfo);
+
+/**
+ * Callback function type for response delivery.
+ * @param[out] object Endpoint object from which the response is received.
+ * @param[out] responseInfo Identifier which needs to be mapped with response.
+ */
+typedef void (*CAResponseCallback)(const CAEndpoint_t *object,
+ const CAResponseInfo_t *responseInfo);
+/**
+ * Callback function type for error.
+ * @param[out] object remote device information.
+ * @param[out] errorInfo CA Error information.
+ */
+typedef void (*CAErrorCallback)(const CAEndpoint_t *object,
+ const CAErrorInfo_t *errorInfo);
+
+/**
+ * Callback function type for network status changes delivery from CA common logic.
+ * @param[out] info Endpoint object from which the network status is changed.
+ * It contains endpoint address based on the connectivity type.
+ * @param[out] status Current network status info.
+ */
+typedef void (*CANetworkMonitorCallback)(const CAEndpoint_t *info, CANetworkStatus_t status);
+
+/**
+ * Callback function type for editing bluetooth advertisement data before starting bluetooth advertisement.
+ * param[in] max_data_size Maximal size of advertisement data array
+ * param[out] data Advertisement data array
+ * param[out] data_size Actual Data size of advertisement data array
+ */
+typedef void (*CAAdvertisementDataGetterCB)(int max_data_size, char *data, int *data_size);
#ifdef __cplusplus
} /* extern "C" */
#endif
-#endif //#ifndef __CA_COMMON_H_
+#endif // CA_COMMON_H_
projects / platform / upstream / iotivity.git / blobdiff