/**
* @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_
+#ifdef TCP_ADAPTER
+#define HAVE_SYS_POLL_H
+#endif
+
#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>
+#ifdef HAVE_SYS_POLL_H
+#include <sys/poll.h>
+#endif
#ifdef __cplusplus
extern "C"
#endif
/**
- * @brief IP address Length
+ * IP address Length
*/
#define CA_IPADDR_SIZE 16
/**
- * @brief Mac address length for BT port
+ * Remote Access jabber ID length.
+ */
+#define CA_RAJABBERID_SIZE 256
+
+/**
+ * Mac address length for BT port
*/
#define CA_MACADDR_SIZE 18
/**
- * @brief Max header options data length
+ * Max header options data length
*/
-#define CA_MAX_HEADER_OPTION_DATA_LENGTH 16
+#define CA_MAX_HEADER_OPTION_DATA_LENGTH 20
/**
-* @brief Max token length
+* Max token length
*/
#define CA_MAX_TOKEN_LEN (8)
/**
- * @brief Max URI length
+ * Max URI length
*/
#ifdef ARDUINO
#define CA_MAX_URI_LENGTH 128 /* maximum size of URI for embedded platforms*/
#endif
/**
- * @brief Max PDU length supported
+ * Max PDU length supported
*/
#ifdef ARDUINO
#define COAP_MAX_PDU_SIZE 320 /* maximum size of a CoAP PDU for embedded platforms*/
#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 (32)
+
/**
- * @brief option types - the highest option number 63
+ * option types - the highest option number 63
*/
#define CA_OPTION_IF_MATCH 1
#define CA_OPTION_ETAG 4
#define CA_OPTION_LOCATION_QUERY 20
/**
- * @brief Payload information from resource model
+ * Payload information from resource model
*/
-typedef char *CAPayload_t;
+typedef uint8_t *CAPayload_t;
/**
- * @brief URI for the OIC base.CA considers relative URI as the URI.
+ * URI for the OIC base.CA considers relative URI as the URI.
*/
typedef char *CAURI_t;
/**
- * @brief Token information for mapping the request and responses by resource model
+ * Token information for mapping the request and responses by resource model
*/
typedef char *CAToken_t;
-/**
- * @enum CATransportType_t
- * @brief Different connectivities that are handled in Connectivity Abstraction
- */
+// 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.
+#ifdef RA_ADAPTER
+#define MAX_ADDR_STR_SIZE_CA (256)
+#else
+#define MAX_ADDR_STR_SIZE_CA (40)
+#endif
+
+typedef enum
+{
+ CA_DEFAULT_ADAPTER = 0,
+
+ // 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_IPV4 = (1 << 0), /**< IPV4 Transport Type */
- CA_IPV6 = (1 << 1), /**< IPV6 Transport Type */
- CA_EDR = (1 << 2), /**< EDR Transport Type */
- CA_LE = (1 << 3) /**< LE Transport Type */
-} CATransportType_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;
+
+#define CA_IPFAMILY_MASK (CA_IPV6|CA_IPV4)
+#define CA_SCOPE_MASK 0xf // mask scope bits above
/**
* @enum CANetworkStatus_t
- * @brief Information about the network status.
+ * Information about the network status.
*/
typedef enum
{
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
- {
- char btMacAddress[CA_MACADDR_SIZE]; /**< BT mac address **/
- } BT;
-
- /**
- * @brief LE MAC Information
- */
- struct
- {
- char leMacAddress[CA_MACADDR_SIZE]; /**< BLE mac address **/
- } LE;
-
- /**
- * @brief IP Information
- */
- struct
- {
- char ipAddress[CA_IPADDR_SIZE]; /**< Ip address of the interface**/
- uint16_t port; /**< port information**/
- } IP;
-} CAAddress_t;
+ uint16_t id_length;
+ unsigned char id[CA_MAX_ENDPOINT_IDENTITY_LEN];
+} CARemoteId_t;
/**
* @enum CAMessageType_t
- * @brief Message Type for Base source code
+ * Message Type for Base source code
*/
typedef enum
{
/**
* @enum CAMethod_t
- * @brief Allowed method to be used by resource model
+ * Allowed method to be used by resource model
*/
typedef enum
{
} CAMethod_t;
/**
- * @brief Remote endpoint information for connectivities
+ * block size
+ * it depends on defined size in libCoAP.
*/
-typedef struct
+typedef enum
{
-
- CAURI_t resourceUri; /**< Resource URI information **/
- CAAddress_t addressInfo; /**< Remote Endpoint address **/
- CATransportType_t transportType; /**< Transport Type of the endpoint**/
- bool isSecured; /**< Secure connection**/
-} 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
{
- CAURI_t resourceUri; /**< Resource URI information **/
- CATransportType_t transportType; /**< Transport type of the endpoint**/
-} 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 interface; // usually zero for default interface
+#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
{
- CAAddress_t addressInfo; /**< Address of the interface **/
- CATransportType_t type; /**< Transport type of local device **/
- bool isSecured; /**< Secure connection**/
-} CALocalConnectivity_t;
+ CAEndpoint_t endpoint; /**< endpoint */
+ CARemoteId_t identity; /**< endpoint identity */
+} CASecureEndpoint_t;
/**
* @enum CAResult_t
- * @brief Enums for CA return values
+ * Enums for CA return values
*/
typedef enum
{
- // Result code - START HERE
+ /* Result code - START HERE */
CA_STATUS_OK = 0, /**< Success */
CA_STATUS_INVALID_PARAM, /**< Invalid Parameter */
CA_ADAPTER_NOT_ENABLED, /**< Adapter is not enabled */
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;
/**
* @enum CAResponseResult_t
- * @brief Enums for CA Response values
+ * Enums for CA Response values
*/
typedef enum
{
/* Response status code - START HERE */
CA_EMPTY = 0, /**< Empty */
- CA_SUCCESS = 200, /**< Success */
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_NOT_ACCEPTABLE = 406, /**< Not Acceptable */
+ CA_REQUEST_ENTITY_INCOMPLETE = 408, /**< Request Entity Incomplete */
+ CA_REQUEST_ENTITY_TOO_LARGE = 413, /**< Request Entity Too Large */
CA_INTERNAL_SERVER_ERROR = 500, /**< Internal Server Error */
CA_RETRANSMIT_TIMEOUT = 504 /**< Retransmit timeout */
/* Response status code - END HERE */
/**
* @enum CATransportProtocolID_t
- * @brief Transport Protocol IDs for additional options
+ * Transport Protocol IDs for additional options
*/
typedef enum
{
/**
* @enum CAAdapterState_t
- * @brief Adapter State to indicate the network changed notifications.
+ * Adapter State to indicate the network changed notifications.
*/
typedef enum
{
} CAAdapterState_t;
/**
- * @brief Header options structure to be filled
+ * 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.
*/
uint16_t optionID; /**< The header option ID which will be
added to communication packets */
uint16_t optionLength; /**< Option Length **/
- uint8_t optionData[CA_MAX_HEADER_OPTION_DATA_LENGTH]; /**< Optional data values**/
+ 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
*/
{
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 */
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 */
} CAInfo_t;
/**
- * @brief Request Information to be sent
+ * Request Information to be sent
*
* This structure is used to hold request information
*/
{
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
*/
{
CAResponseResult_t result; /**< Result for response by resource model */
CAInfo_t info; /**< Information of the response */
+ bool isMulticast;
} CAResponseInfo_t;
+/**
+ * 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
+{
+ int 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
+{
+ int32_t ifIndex; /**< network interface index */
+} CAIfItem_t;
+
+typedef struct
+{
+ CATransportFlags_t clientFlags; /**< flag for client */
+ CATransportFlags_t serverFlags; /**< flag for server */
+ bool client; /**< client mode */
+ bool server; /**< server mode */
+
+ 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 */
+ int netlinkFd; /**< netlink */
+ int shutdownFds[2]; /**< shutdown pipe */
+ int selectTimeout; /**< in seconds */
+ int maxfd; /**< highest fd (for select) */
+ 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 */
+
+ 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 ipv6; /**< IPv6 accept socket */
+ void *svrlist; /**< unicast IPv4 TCP server information*/
+ int selectTimeout; /**< in seconds */
+ int listenBacklog; /**< backlog counts*/
+ int shutdownFds[2]; /**< shutdown pipe */
+ int connectionFds[2]; /**< connection pipe */
+ int maxfd; /**< highest fd (for select) */
+ bool started; /**< the TCP adapter has started */
+ bool terminate; /**< the TCP adapter needs to stop */
+ bool ipv4tcpenabled; /**< IPv4 TCP enabled by OCInit flags */
+ bool ipv6tcpenabled; /**< IPv6 TCP enabled by OCInit flags */
+ } tcp;
+#endif
+} CAGlobals_t;
+
+extern CAGlobals_t caglobals;
+
+/**
+ * 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);
+
#ifdef __cplusplus
} /* extern "C" */
#endif
-#endif /* CA_COMMON_H_ */
-
+#endif // CA_COMMON_H_
projects / platform / upstream / iotivity.git / blobdiff