#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
/**
- * 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
#define CA_RAJABBERID_SIZE 256
/**
- * Mac address length for BT port
+ * Mac address length for BT port.
*/
#define CA_MACADDR_SIZE 18
/**
- * Max header options data length
+ * Max header options data length.
*/
+#if defined(ARDUINO) || defined(__TIZENRT__)
#define CA_MAX_HEADER_OPTION_DATA_LENGTH 20
+#else
+#define CA_MAX_HEADER_OPTION_DATA_LENGTH 1024
+#endif
/**
-* Max token length
+* Max token length.
*/
#define CA_MAX_TOKEN_LEN (8)
/**
- * Max URI length
+* 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*/
#endif
/**
- * 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*/
#endif
/**
- *Maximum length of the remoteEndpoint identity
+ *Maximum length of the remoteEndpoint identity.
*/
-#define CA_MAX_ENDPOINT_IDENTITY_LEN (32)
+#define CA_MAX_ENDPOINT_IDENTITY_LEN CA_MAX_IDENTITY_SIZE
/**
- * option types - the highest option number 63
+ * 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_LOCATION_QUERY 20
/**
- * Payload information from resource model
+ * Payload information from resource model.
*/
typedef uint8_t *CAPayload_t;
typedef char *CAURI_t;
/**
- * 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;
-// 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.
+/*
+ * Socket types and error definitions.
+ */
+#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
+
+/*
+ * 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)
+/*
+ * 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)
+ */
+#define MAX_ADDR_STR_SIZE_CA (66)
#endif
typedef enum
CA_SCOPE_GLOBAL = 0xE, // IPv6 Global scope
} CATransportFlags_t;
+typedef enum
+{
+ 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
/**
- * @enum CANetworkStatus_t
* Information about the network status.
*/
typedef enum
} CANetworkStatus_t;
/*
- * remoteEndpoint identity
+ * remoteEndpoint identity.
*/
typedef struct
{
} CARemoteId_t;
/**
- * @enum CAMessageType_t
- * Message Type for Base source code
+ * Message Type for Base source code.
*/
typedef enum
{
} CAMessageType_t;
/**
- * @enum CAMethod_t
- * Allowed method to be used by resource model
+ * Allowed method to be used by resource model.
*/
typedef enum
{
} CAMethod_t;
/**
- * block size
+ * block size.
* it depends on defined size in libCoAP.
*/
typedef enum
} CABlockSize_t;
/**
- * Endpoint information for connectivities
+ * Endpoint information for connectivities.
* Must be identical to OCDevAddr.
*/
typedef struct
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
+ 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. **/
} CAEndpoint_t;
/**
- * Endpoint information for secure messages
+ * Endpoint information for secure messages.
*/
typedef struct
{
CAEndpoint_t endpoint; /**< endpoint */
- CARemoteId_t identity; /**< endpoint identity */
+ // TODO change name to deviceId
+ CARemoteId_t identity; /**< endpoint device uuid */
+ CARemoteId_t userId; /**< endpoint user uuid */
} CASecureEndpoint_t;
/**
- * @enum CAResult_t
- * Enums for CA return values
+ * Enums for CA return values.
*/
typedef enum
{
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_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 */
} CAResult_t;
/**
- * @enum CAResponseResult_t
- * Enums for CA Response values
+ * Enums for CA Response values.
*/
typedef enum
{
/* 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_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 */
+ 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;
/**
- * @enum CATransportProtocolID_t
- * 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
{
} CATransportProtocolID_t;
/**
- * @enum CAAdapterState_t
* Adapter State to indicate the network changed notifications.
*/
typedef enum
} CAPayloadFormat_t;
/**
- * Header options structure to be filled
+ * Header options structure to be filled.
*
* This structure is used to hold header information.
*/
} CAHeaderOption_t;
/**
- * 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
{
-
CAMessageType_t type; /**< Qos for the request */
#ifdef ROUTING_GATEWAY
bool skipRetransmission; /**< Will not attempt retransmission even if type is CONFIRM.
* 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*/
+ 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 */
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;
/**
- * 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
{
} CARequestInfo_t;
/**
- * Response information received
+ * Response information received.
*
- * This structure is used to hold response information
+ * This structure is used to hold response information.
*/
typedef struct
{
/**
* Error information from CA
- * contains error code and message information
+ * contains error code and message information.
*
- * This structure holds error information
+ * This structure holds error information.
*/
typedef struct
{
} CAErrorInfo_t;
/**
- * Hold global variables for CA layer (also used by RI layer)
+ * Hold global variables for CA layer. (also used by RI layer)
*/
typedef struct
{
- int fd; /**< socket fd */
- uint16_t port; /**< socket port */
+ CASocketFd_t fd; /**< socket fd */
+ uint16_t port; /**< socket port */
} CASocket_t;
#define HISTORYSIZE (4)
} CAHistory_t;
/**
- * Hold interface index for keeping track of comings and goings
+ * Hold interface index for keeping track of comings and goings.
*/
typedef struct
{
int32_t ifIndex; /**< network interface index */
} CAIfItem_t;
+/**
+ * Hold the port number assigned from application.
+ * It will be used when creating a socket.
+ */
+typedef struct
+{
+ 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 */
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 */
- 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 */
+ 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
{
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 */
- int maxfd; /**< highest fd (for select) */
+#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.
*/
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
projects / platform / upstream / iotivity.git / blobdiff