// See the License for the specific language governing permissions and
// limitations under the License.
//
-//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+//******************************************************************
+
+
+/**
+ * @file
+ *
+ * This file contains the definition, types and APIs for resource(s) be implemented.
+ */
#ifndef OCTYPES_H_
#define OCTYPES_H_
+#include "platform_features.h"
#include "ocstackconfig.h"
#include <stdbool.h>
#include <stdint.h>
extern "C" {
#endif // __cplusplus
+
+/** For the feature presence.*/
#define WITH_PRESENCE
+
#include "ocpresence.h"
//-----------------------------------------------------------------------------
// Defines
/**
* OIC Virtual resources supported by every OIC device.
*/
+/**
+ * Default discovery mechanism using '/oic/res' is supported by all OIC devices
+ * That are Discoverable.
+ */
#define OC_RSRVD_WELL_KNOWN_URI "/oic/res"
+
+/** Device URI.*/
#define OC_RSRVD_DEVICE_URI "/oic/d"
+
+/** Platform URI.*/
#define OC_RSRVD_PLATFORM_URI "/oic/p"
+
+/** Resource Type.*/
#define OC_RSRVD_RESOURCE_TYPES_URI "/oic/res/types/d"
+#ifdef ROUTING_GATEWAY
+/** Gateway URI.*/
+#define OC_RSRVD_GATEWAY_URI "/oic/gateway"
+#endif
#ifdef WITH_PRESENCE
+
+/** Presence URI through which the OIC devices advertise their presence.*/
#define OC_RSRVD_PRESENCE_URI "/oic/ad"
+
+/** Sets the default time to live (TTL) for presence.*/
#define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
-/// OC_MAX_PRESENCE_TTL_SECONDS sets the maximum time to live (TTL) for presence.
-/// NOTE: Changing the setting to a longer duration may lead to unsupported and untested
-/// operation.
-#define OC_MAX_PRESENCE_TTL_SECONDS (60 * 60 * 24) // 60 sec/min * 60 min/hr * 24 hr/day
-#endif
-///Separtor for multiple query string
+/** For multicast Discovery mechanism.*/
+#define OC_MULTICAST_DISCOVERY_URI "/oic/res"
+
+/** Separator for multiple query string.*/
#define OC_QUERY_SEPARATOR "&;"
/**
- * Attributes used to form a proper OIC conforming JSON message.
+ * OC_DEFAULT_PRESENCE_TTL_SECONDS sets the default time to live (TTL) for presence.
*/
-//#define OC_RSRVD_OC "oic"
+#define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
+
+/**
+ * OC_MAX_PRESENCE_TTL_SECONDS sets the maximum time to live (TTL) for presence.
+ * NOTE: Changing the setting to a longer duration may lead to unsupported and untested
+ * operation.
+ * 60 sec/min * 60 min/hr * 24 hr/day
+ */
+#define OC_MAX_PRESENCE_TTL_SECONDS (60 * 60 * 24)
+#endif
+
+/**
+ * Presence "Announcement Triggers".
+ */
+
+/** To create.*/
+#define OC_RSRVD_TRIGGER_CREATE "create"
+
+/** To change.*/
+#define OC_RSRVD_TRIGGER_CHANGE "change"
+
+/** To delete.*/
+#define OC_RSRVD_TRIGGER_DELETE "delete"
+
+/**
+ * Attributes used to form a proper OIC conforming JSON message.
+ */
+
+#define OC_RSRVD_OC "oic"
+
+/** For payload. */
+
#define OC_RSRVD_PAYLOAD "payload"
+
+/** To represent href */
#define OC_RSRVD_HREF "href"
+
+/** To represent property*/
#define OC_RSRVD_PROPERTY "prop"
+
+/** For representation.*/
#define OC_RSRVD_REPRESENTATION "rep"
+
+/** To represent content type.*/
#define OC_RSRVD_CONTENT_TYPE "ct"
+
+/** To represent resource type.*/
#define OC_RSRVD_RESOURCE_TYPE "rt"
+
+/** To represent resource type with presence.*/
#define OC_RSRVD_RESOURCE_TYPE_PRESENCE "oic.wk.ad"
+
+/** To represent interface.*/
#define OC_RSRVD_INTERFACE "if"
+
+/** To represent time to live.*/
#define OC_RSRVD_TTL "ttl"
+
+/** To represent non*/
#define OC_RSRVD_NONCE "non"
+
+/** To represent trigger type.*/
#define OC_RSRVD_TRIGGER "trg"
+
+/** To represent links.*/
#define OC_RSRVD_LINKS "links"
+/** To represent default interface.*/
#define OC_RSRVD_INTERFACE_DEFAULT "oic.if.baseline"
+
+/** To represent ll interface.*/
#define OC_RSRVD_INTERFACE_LL "oic.if.ll"
+
+/** To represent batch interface.*/
#define OC_RSRVD_INTERFACE_BATCH "oic.if.b"
+
+/** To represent interface group.*/
#define OC_RSRVD_INTERFACE_GROUP "oic.mi.grp"
+
+/** To represent MFG date.*/
#define OC_RSRVD_MFG_DATE "mndt"
+
+/** To represent FW version.*/
#define OC_RSRVD_FW_VERSION "mnfv"
+
+/** To represent host name.*/
#define OC_RSRVD_HOST_NAME "hn"
+
+/** To represent version.*/
#define OC_RSRVD_VERSION "icv"
+
+/** To represent policy.*/
#define OC_RSRVD_POLICY "p"
+
+/** To represent bitmap.*/
#define OC_RSRVD_BITMAP "bm"
+
+/** For security.*/
#define OC_RSRVD_SECURE "sec"
+
+/** Port. */
#define OC_RSRVD_HOSTING_PORT "port"
+
+/** For Server instance ID.*/
#define OC_RSRVD_SERVER_INSTANCE_ID "sid"
-//**** Presence "Announcement Triggers" ****
-#define OC_RSRVD_TRIGGER_CREATE "create"
-#define OC_RSRVD_TRIGGER_CHANGE "change"
-#define OC_RSRVD_TRIGGER_DELETE "delete"
-//*******************
+/**
+ * Platform.
+ */
-//**** Platform ****
+/** Platform ID. */
#define OC_RSRVD_PLATFORM_ID "pi"
+
+/** Platform MFG NAME. */
#define OC_RSRVD_MFG_NAME "mnmn"
+
+/** Platform URL. */
#define OC_RSRVD_MFG_URL "mnml"
+
+/** Model Number.*/
#define OC_RSRVD_MODEL_NUM "mnmo"
+
+/** Platform MFG Date.*/
#define OC_RSRVD_MFG_DATE "mndt"
+
+/** Platform versio.n */
#define OC_RSRVD_PLATFORM_VERSION "mnpv"
+
+/** Platform Operating system version. */
#define OC_RSRVD_OS_VERSION "mnos"
+
+/** Platform Hardware version. */
#define OC_RSRVD_HARDWARE_VERSION "mnhw"
+
+/**Platform Firmware version. */
#define OC_RSRVD_FIRMWARE_VERSION "mnfv"
+
+/** Support URL for the platform. */
#define OC_RSRVD_SUPPORT_URL "mnsl"
+
+/** System time for the platform. */
#define OC_RSRVD_SYSTEM_TIME "st"
-//*******************
-//**** Device ****
+/**
+ * Device.
+ */
+
+/** Device ID.*/
#define OC_RSRVD_DEVICE_ID "di"
+
+/** Device Name.*/
#define OC_RSRVD_DEVICE_NAME "n"
+
+/** Device specification version.*/
#define OC_RSRVD_SPEC_VERSION "lcv"
+
+/** Device data model.*/
#define OC_RSRVD_DATA_MODEL_VERSION "dmv"
+/** Device specification version.*/
#define OC_SPEC_VERSION "0.9.0"
+
+/** Device Data Model version.*/
#define OC_DATA_MODEL_VERSION "sec.0.95"
-//*******************
-// These provide backward compatibility - their use is deprecated
+/**
+ * These provide backward compatibility - their use is deprecated.
+ */
#ifndef GOING_AWAY
+
+/** Multicast Prefix.*/
#define OC_MULTICAST_PREFIX "224.0.1.187:5683"
+
+/** Multicast IP address.*/
#define OC_MULTICAST_IP "224.0.1.187"
+
+/** Multicast Port.*/
#define OC_MULTICAST_PORT 5683
#endif // GOING_AWAY
-//-----------------------------------------------------------------------------
-// Typedefs
-//-----------------------------------------------------------------------------
+/** Max Device address size. */
#ifdef RA_ADAPTER
#define MAX_ADDR_STR_SIZE (256)
#else
#define MAX_ADDR_STR_SIZE (40)
- #endif
+#endif
+/** Max identity size. */
#define MAX_IDENTITY_SIZE (32)
+/** Resource Directory */
-/*
+/** Resource Directory URI used to Discover RD and Publish resources.*/
+#define OC_RSRVD_RD_URI "/oic/rd"
+
+/** To represent resource type with rd.*/
+#define OC_RSRVD_RESOURCE_TYPE_RD "oic.wk.rd"
+
+/** RD Discovery bias factor type. */
+#define OC_RSRVD_RD_DISCOVERY_SEL "sel"
+
+/** Base URI. */
+#define OC_RSRVD_BASE_URI "baseURI"
+
+/** Unique value per collection/link. */
+#define OC_RSRVD_INS "ins"
+
+/** Allowable resource types in the links. */
+#define OC_RSRVD_RTS "rts"
+
+/** Default relationship. */
+#define OC_RSRVD_DREL "drel"
+
+/** Defines relationship between links. */
+#define OC_RSRVD_REL "rel"
+
+/** Defines title. */
+#define OC_RSRVD_TITLE "title"
+
+/** Defines URI. */
+#define OC_RSRVD_URI "uri"
+
+/** Defines media type. */
+#define OC_RSRVD_MEDIA_TYPE "mt"
+
+/** To represent resource type with Publish RD.*/
+#define OC_RSRVD_RESOURCE_TYPE_RDPUBLISH "oic.wk.rdPub"
+
+/**
* These enums (OCTransportAdapter and OCTransportFlags) must
* be kept synchronized with OCConnectivityType (below) as well as
* CATransportAdapter and CATransportFlags (in CACommon.h).
*/
-
typedef enum
{
+ /** value zero indicates discovery.*/
OC_DEFAULT_ADAPTER = 0,
- // value zero indicates discovery
- OC_ADAPTER_IP = (1 << 0), // IPv4 and IPv6, including 6LoWPAN
- OC_ADAPTER_GATT_BTLE = (1 << 1), // GATT over Bluetooth LE
- OC_ADAPTER_RFCOMM_BTEDR = (1 << 2), // RFCOMM over Bluetooth EDR
+ /** IPv4 and IPv6, including 6LoWPAN.*/
+ OC_ADAPTER_IP = (1 << 0),
+
+ /** GATT over Bluetooth LE.*/
+ OC_ADAPTER_GATT_BTLE = (1 << 1),
+
+ /** RFCOMM over Bluetooth EDR.*/
+ OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
+
+#ifdef RA_ADAPTER
+ /**Remote Access over XMPP.*/
+ OC_ADAPTER_REMOTE_ACCESS = (1 << 3),
+#endif
+
+#ifdef TCP_ADAPTER
+ /** CoAP over TCP.*/
+ OC_ADAPTER_TCP = (1 << 4)
+#endif
- #ifdef RA_ADAPTER
- OC_ADAPTER_REMOTE_ACCESS = (1 << 3) // Remote Access over XMPP.
- #endif
} OCTransportAdapter;
-// enum layout assumes some targets have 16-bit integer (e.g., Arduino)
+/**
+ * Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
+ */
typedef enum
{
+ /** default flag is 0*/
OC_DEFAULT_FLAGS = 0,
- // Insecure transport is the default (subject to change)
- OC_FLAG_SECURE = (1 << 4), // secure the transport path
+ /** Insecure transport is the default (subject to change).*/
+ /** secure the transport path*/
+ OC_FLAG_SECURE = (1 << 4),
- // IPv4 & IPv6 autoselection is the default
- OC_IP_USE_V6 = (1 << 5), // IP adapter only
- OC_IP_USE_V4 = (1 << 6), // IP adapter only
+ /** IPv4 & IPv6 auto-selection is the default.*/
+ /** IP adapter only.*/
+ OC_IP_USE_V6 = (1 << 5),
+ /** IP adapter only.*/
+ OC_IP_USE_V4 = (1 << 6),
+
+ /** internal use only.*/
OC_RESERVED1 = (1 << 7), // internal use only
- // Link-Local multicast is the default multicast scope for IPv6.
- // These are placed here to correspond to the IPv6 multicast address bits.
- OC_SCOPE_INTERFACE = 0x1, // IPv6 Interface-Local scope (loopback)
- OC_SCOPE_LINK = 0x2, // IPv6 Link-Local scope (default)
- OC_SCOPE_REALM = 0x3, // IPv6 Realm-Local scope
- OC_SCOPE_ADMIN = 0x4, // IPv6 Admin-Local scope
- OC_SCOPE_SITE = 0x5, // IPv6 Site-Local scope
- OC_SCOPE_ORG = 0x8, // IPv6 Organization-Local scope
- OC_SCOPE_GLOBAL = 0xE, // IPv6 Global scope
+ /** Link-Local multicast is the default multicast scope for IPv6.
+ * These are placed here to correspond to the IPv6 multicast address bits.*/
+
+ /** IPv6 Interface-Local scope (loopback).*/
+ OC_SCOPE_INTERFACE = 0x1,
+
+ /** IPv6 Link-Local scope (default).*/
+ OC_SCOPE_LINK = 0x2,
+
+ /** IPv6 Realm-Local scope. */
+ OC_SCOPE_REALM = 0x3,
+
+ /** IPv6 Admin-Local scope. */
+ OC_SCOPE_ADMIN = 0x4,
+
+ /** IPv6 Site-Local scope. */
+ OC_SCOPE_SITE = 0x5,
+
+ /** IPv6 Organization-Local scope. */
+ OC_SCOPE_ORG = 0x8,
+
+ /**IPv6 Global scope. */
+ OC_SCOPE_GLOBAL = 0xE,
+
} OCTransportFlags;
+/** Bit mask for scope.*/
#define OC_MASK_SCOPE (0x000F)
+
+/** Bit mask for Mods.*/
#define OC_MASK_MODS (0x0FF0)
#define OC_MASK_FAMS (OC_IP_USE_V6|OC_IP_USE_V4)
-/*
- * endpoint identity
+/**
+ * End point identity.
*/
typedef struct
{
+ /** Identity Length */
uint16_t id_length;
+
+ /** Array of end point identity.*/
unsigned char id[MAX_IDENTITY_SIZE];
} OCIdentity;
/**
* Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
- *
* OCDevAddr must be the same as CAEndpoint (in CACommon.h).
*/
typedef struct
{
- OCTransportAdapter adapter; // adapter type
- OCTransportFlags flags; // transport modifiers
- char addr[MAX_ADDR_STR_SIZE]; // address for all adapters
- uint32_t interface; // usually zero for default interface
- uint16_t port; // for IP
- OCIdentity identity; // secure node identity
+ /** adapter type.*/
+ OCTransportAdapter adapter;
+
+ /** transport modifiers.*/
+ OCTransportFlags flags;
+
+ /** for IP.*/
+ uint16_t port;
+
+ /** address for all adapters.*/
+ char addr[MAX_ADDR_STR_SIZE];
+
+ /** usually zero for default interface.*/
+ uint32_t interface;
+#if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
+ char routeData[MAX_ADDR_STR_SIZE]; //destination GatewayID:ClientId
+#endif
} OCDevAddr;
-/*
- * OCConnectivityType includes elements of both OCTransportAdapter
- * and OCTransportFlags. It is defined conditionally because the
- * smaller definition limits expandability on 32/64 bit integer machines,
- * and the larger definition won't fit into an enum on 16-bit integer
- * machines like Arduino.
+/**
+ * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
+ * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
+ * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
+ * like Arduino.
*
- * This structure must directly correspond to OCTransportAdapter
- * and OCTransportFlags.
+ * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
*/
typedef enum
{
- CT_DEFAULT = 0, // use when defaults are ok
+ /** use when defaults are ok. */
+ CT_DEFAULT = 0,
- #if defined (__UINT32_MAX__) && (__UINT32_MAX__ == 65535) // 16-bit int
- CT_ADAPTER_IP = (1 << 10), // IPv4 and IPv6, including 6LoWPAN
- CT_ADAPTER_GATT_BTLE = (1 << 11), // GATT over Bluetooth LE
- CT_ADAPTER_RFCOMM_BTEDR = (1 << 12), // RFCOMM over Bluetooth EDR
- #ifdef RA_ADAPTER
- CT_ADAPTER_REMOTE_ACCESS = (1 << 13), // Remote Access over XMPP
- #endif
- #define CT_ADAPTER_SHIFT 10
- #define CT_MASK_FLAGS 0x03FF
- #define CT_MASK_ADAPTER 0xFC00
- #else // assume 32-bit int
- CT_ADAPTER_IP = (1 << 16), // IPv4 and IPv6, including 6LoWPAN
- CT_ADAPTER_GATT_BTLE = (1 << 17), // GATT over Bluetooth LE
- CT_ADAPTER_RFCOMM_BTEDR = (1 << 18), // RFCOMM over Bluetooth EDR
- #ifdef RA_ADAPTER
- CT_ADAPTER_REMOTE_ACCESS = (1 << 19), // Remote Access over XMPP
- #endif
- #define CT_ADAPTER_SHIFT 16
- #define CT_MASK_FLAGS 0xFFFF
- #define CT_MASK_ADAPTER 0xFFFF0000
- #endif
+ /** IPv4 and IPv6, including 6LoWPAN.*/
+ CT_ADAPTER_IP = (1 << 16),
+
+ /** GATT over Bluetooth LE.*/
+ CT_ADAPTER_GATT_BTLE = (1 << 17),
+
+ /** RFCOMM over Bluetooth EDR.*/
+ CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
+
+#ifdef RA_ADAPTER
+ /** Remote Access over XMPP.*/
+ CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
+#endif
+
+#ifdef TCP_ADAPTER
+ /** CoAP over TCP.*/
+ CT_ADAPTER_TCP = (1 << 20),
+#endif
+
+ /** Insecure transport is the default (subject to change).*/
+
+ /** secure the transport path.*/
+ CT_FLAG_SECURE = (1 << 4),
+
+ /** IPv4 & IPv6 autoselection is the default.*/
+
+ /** IP adapter only.*/
+ CT_IP_USE_V6 = (1 << 5),
+
+ /** IP adapter only.*/
+ CT_IP_USE_V4 = (1 << 6),
+
+ /** Link-Local multicast is the default multicast scope for IPv6.
+ * These are placed here to correspond to the IPv6 address bits.*/
+
+ /** IPv6 Interface-Local scope(loopback).*/
+ CT_SCOPE_INTERFACE = 0x1,
+
+ /** IPv6 Link-Local scope (default).*/
+ CT_SCOPE_LINK = 0x2,
- // Insecure transport is the default (subject to change)
- CT_FLAG_SECURE = (1 << 4), // secure the transport path
-
- // IPv4 & IPv6 autoselection is the default
- CT_IP_USE_V6 = (1 << 5), // IP adapter only
- CT_IP_USE_V4 = (1 << 6), // IP adapter only
-
- // Link-Local multicast is the default multicast scope for IPv6.
- // These are placed here to correspond to the IPv6 address bits.
- CT_SCOPE_INTERFACE = 0x1, // IPv6 Interface-Local scope (loopback)
- CT_SCOPE_LINK = 0x2, // IPv6 Link-Local scope (default)
- CT_SCOPE_REALM = 0x3, // IPv6 Realm-Local scope
- CT_SCOPE_ADMIN = 0x4, // IPv6 Admin-Local scope
- CT_SCOPE_SITE = 0x5, // IPv6 Site-Local scope
- CT_SCOPE_ORG = 0x8, // IPv6 Organization-Local scope
- CT_SCOPE_GLOBAL = 0xE, // IPv6 Global scope
+ /** IPv6 Realm-Local scope.*/
+ CT_SCOPE_REALM = 0x3,
+
+ /** IPv6 Admin-Local scope.*/
+ CT_SCOPE_ADMIN = 0x4,
+
+ /** IPv6 Site-Local scope.*/
+ CT_SCOPE_SITE = 0x5,
+
+ /** IPv6 Organization-Local scope.*/
+ CT_SCOPE_ORG = 0x8,
+
+ /** IPv6 Global scope.*/
+ CT_SCOPE_GLOBAL = 0xE,
} OCConnectivityType;
+/** bit shift required for connectivity adapter.*/
+#define CT_ADAPTER_SHIFT 16
+
+/** Mask Flag.*/
+#define CT_MASK_FLAGS 0xFFFF
+
+/** Mask Adapter.*/
+#define CT_MASK_ADAPTER 0xFFFF0000
+
/**
- * OCDoResource methods
+ * OCDoResource methods to dispatch the request
*/
typedef enum
{
OC_REST_NOMETHOD = 0,
- OC_REST_GET = (1 << 0), ///< Read
- OC_REST_PUT = (1 << 1), ///< Write
- OC_REST_POST = (1 << 2), ///< Update
- OC_REST_DELETE = (1 << 3), ///< Delete
- /// Register observe request for most up date notifications ONLY.
+
+ /** Read.*/
+ OC_REST_GET = (1 << 0),
+
+ /** Write.*/
+ OC_REST_PUT = (1 << 1),
+
+ /** Update.*/
+ OC_REST_POST = (1 << 2),
+
+ /** Delete.*/
+ OC_REST_DELETE = (1 << 3),
+
+ /** Register observe request for most up date notifications ONLY.*/
OC_REST_OBSERVE = (1 << 4),
- /// Register observe request for all notifications, including stale notifications.
+
+ /** Register observe request for all notifications, including stale notifications.*/
OC_REST_OBSERVE_ALL = (1 << 5),
- /// Deregister observation, intended for internal use
+
+ /** De-register observation, intended for internal use.*/
OC_REST_CANCEL_OBSERVE = (1 << 6),
+
#ifdef WITH_PRESENCE
- /// Subscribe for all presence notifications of a particular resource.
+ /** Subscribe for all presence notifications of a particular resource.*/
OC_REST_PRESENCE = (1 << 7),
+
#endif
- /// Allows OCDoResource caller to do discovery.
+ /** Allows OCDoResource caller to do discovery.*/
OC_REST_DISCOVER = (1 << 8)
} OCMethod;
/**
+ * Formats for payload encoding.
+ */
+typedef enum
+{
+ OC_FORMAT_CBOR,
+ OC_FORMAT_UNDEFINED,
+ OC_FORMAT_UNSUPPORTED,
+} OCPayloadFormat;
+
+/**
* Host Mode of Operation.
*/
typedef enum
{
OC_CLIENT = 0,
OC_SERVER,
- OC_CLIENT_SERVER
+ OC_CLIENT_SERVER,
+ OC_GATEWAY /**< Client server mode along with routing capabilities.*/
} OCMode;
/**
- * Quality of Service.
- *
- * OCQualityOfService attempts to abstract the guarantees provided by the underlying transport
- * protocol. The precise definitions of each quality of service level depend on the
- * implementation. In descriptions below are for the current implementation and may changed
+ * Quality of Service attempts to abstract the guarantees provided by the underlying transport
+ * protocol. The precise definitions of each quality of service level depend on the
+ * implementation. In descriptions below are for the current implementation and may changed
* over time.
*/
typedef enum
{
- /// Packet delivery is best effort
+ /** Packet delivery is best effort.*/
OC_LOW_QOS = 0,
- /// Packet delivery is best effort
+
+ /** Packet delivery is best effort.*/
OC_MEDIUM_QOS,
- /// Acknowledgements are used to confirm delivery
+
+ /** Acknowledgments are used to confirm delivery.*/
OC_HIGH_QOS,
- /// No Quality is defined, let the stack decide
+
+ /** No Quality is defined, let the stack decide.*/
OC_NA_QOS
} OCQualityOfService;
* The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
* Not including the policy property is equivalent to zero.
*
- * ::OC_RES_PROP_NONE When none of the bits are set, the resource is non-discoverable &
- * non-observable by the client.
- * ::OC_DISCOVERABLE When this bit is set, the resource is allowed to be discovered by clients.
- * ::OC_OBSERVABLE When this bit is set, the resource is allowed to be observed by clients.
- * ::OC_ACTIVE When this bit is set, the resource is initialized, otherwise the resource
- * is 'inactive'. 'inactive' signifies that the resource has been marked for
- * deletion or is already deleted.
- * ::OC_SLOW When this bit is set, the resource has been marked as 'slow'. 'slow'
- * signifies that responses from this resource can expect delays in
- * processing its requests from clients.
- * ::OC_SECURE When this bit is set, the resource is a secure resource.
- * ::OC_EXPLICIT_DISCOVERABLE When this bit is set, the resource is allowed to be discovered only
- * if discovery request contains an explicit querystring.
- * Ex: GET /oic/res?rt=oic.sec.acl
*/
typedef enum
{
+ /** When none of the bits are set, the resource is non-discoverable &
+ * non-observable by the client.*/
OC_RES_PROP_NONE = (0),
+
+ /** When this bit is set, the resource is allowed to be discovered by clients.*/
OC_DISCOVERABLE = (1 << 0),
+
+ /** When this bit is set, the resource is allowed to be observed by clients.*/
OC_OBSERVABLE = (1 << 1),
+
+ /** When this bit is set, the resource is initialized, otherwise the resource
+ * is 'inactive'. 'inactive' signifies that the resource has been marked for
+ * deletion or is already deleted.*/
OC_ACTIVE = (1 << 2),
+
+ /** When this bit is set, the resource has been marked as 'slow'.
+ * 'slow' signifies that responses from this resource can expect delays in
+ * processing its requests from clients.*/
OC_SLOW = (1 << 3),
+
+ /** When this bit is set, the resource is a secure resource.*/
OC_SECURE = (1 << 4),
+
+ /** When this bit is set, the resource is allowed to be discovered only
+ * if discovery request contains an explicit querystring.
+ * Ex: GET /oic/res?rt=oic.sec.acl */
OC_EXPLICIT_DISCOVERABLE = (1 << 5)
} OCResourceProperty;
*/
typedef enum
{
+ /** For invalid ID.*/
OC_INVALID_ID = (1 << 0),
+
+ /* For coap ID.*/
OC_COAP_ID = (1 << 1)
} OCTransportProtocolID;
*/
typedef enum
{
- /* Success status code - START HERE */
+ /** Success status code - START HERE.*/
OC_STACK_OK = 0,
OC_STACK_RESOURCE_CREATED,
OC_STACK_RESOURCE_DELETED,
OC_STACK_CONTINUE,
- /* Success status code - END HERE */
- /* Error status code - START HERE */
+ /** Success status code - END HERE.*/
+
+ /** Error status code - START HERE.*/
OC_STACK_INVALID_URI = 20,
OC_STACK_INVALID_QUERY,
OC_STACK_INVALID_IP,
OC_STACK_INVALID_PORT,
OC_STACK_INVALID_CALLBACK,
OC_STACK_INVALID_METHOD,
+
+ /** Invalid parameter.*/
OC_STACK_INVALID_PARAM,
OC_STACK_INVALID_OBSERVE_PARAM,
OC_STACK_NO_MEMORY,
OC_STACK_TIMEOUT,
OC_STACK_ADAPTER_NOT_ENABLED,
OC_STACK_NOTIMPL,
- OC_STACK_NO_RESOURCE, /* resource not found */
- OC_STACK_RESOURCE_ERROR, /* ex: not supported method or interface */
+
+ /** Resource not found.*/
+ OC_STACK_NO_RESOURCE,
+
+ /** e.g: not supported method or interface.*/
+ OC_STACK_RESOURCE_ERROR,
OC_STACK_SLOW_RESOURCE,
OC_STACK_DUPLICATE_REQUEST,
- OC_STACK_NO_OBSERVERS, /* resource has no registered observers */
+
+ /** Resource has no registered observers.*/
+ OC_STACK_NO_OBSERVERS,
OC_STACK_OBSERVER_NOT_FOUND,
OC_STACK_VIRTUAL_DO_NOT_HANDLE,
OC_STACK_INVALID_OPTION,
- OC_STACK_MALFORMED_RESPONSE, /* the remote reply contained malformed data */
+
+ /** The remote reply contained malformed data.*/
+ OC_STACK_MALFORMED_RESPONSE,
OC_STACK_PERSISTENT_BUFFER_REQUIRED,
OC_STACK_INVALID_REQUEST_HANDLE,
OC_STACK_INVALID_DEVICE_INFO,
OC_STACK_INVALID_JSON,
- OC_STACK_UNAUTHORIZED_REQ, /**< Request is not authorized by Resource Server. */
- /* NOTE: Insert all new error codes here!*/
+
+ /** Request is not authorized by Resource Server. */
+ OC_STACK_UNAUTHORIZED_REQ,
+
+ /** Error code from PDM */
+ OC_STACK_PDM_IS_NOT_INITIALIZED,
+ OC_STACK_DUPLICATE_UUID,
+ OC_STACK_INCONSISTENT_DB,
+
+ /** Insert all new error codes here!.*/
#ifdef WITH_PRESENCE
OC_STACK_PRESENCE_STOPPED = 128,
OC_STACK_PRESENCE_TIMEOUT,
OC_STACK_PRESENCE_DO_NOT_HANDLE,
#endif
+ /** ERROR in stack.*/
OC_STACK_ERROR = 255
- /* Error status code - END HERE */
+ /** Error status code - END HERE.*/
} OCStackResult;
/**
- * Handle to an @ref OCDoResource invocation.
+ * Handle to an OCDoResource invocation.
*/
typedef void * OCDoHandle;
*/
typedef void * OCResourceHandle;
+/**
+ * Handle to an OCRequest object owned by the OCStack.
+ */
typedef void * OCRequestHandle;
/**
* Unique identifier for each observation request. Used when observations are
- * registered or deregistering. Used by entity handler to signal specific
+ * registered or de-registered. Used by entity handler to signal specific
* observers to be notified of resource changes.
* There can be maximum of 256 observations per server.
*/
*/
typedef enum
{
+ /** To Register. */
OC_OBSERVE_REGISTER = 0,
+
+ /** To Deregister. */
OC_OBSERVE_DEREGISTER = 1,
+
+ /** Others. */
OC_OBSERVE_NO_OPTION = 2
} OCObserveAction;
/**
- * Persistent storage handlers. An app must provide OCPersistentStorage handler pointers when it
- * calls OCRegisterPersistentStorageHandler.
+ * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
+ * when it calls OCRegisterPersistentStorageHandler.
+ * Persistent storage open handler points to default file path.
+ * Application can point to appropriate SVR database path for it's IoTivity Server.
*/
typedef struct {
- /*
- * Persistent storage open handler points to default file path.
- * Application can point to appropriate SVR database path for its Iotivity Server.
- */
+ /** Persistent storage file path.*/
FILE* (* open)(const char *path, const char *mode);
- // Persistent storage read handler
+
+ /** Persistent storage read handler.*/
size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
- // Persistent storage write handler
+
+ /** Persistent storage write handler.*/
size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
- // Persistent storage close handler
+
+ /** Persistent storage close handler.*/
int (* close)(FILE *fp);
- // Persistent storage unlink handler
+
+ /** Persistent storage unlink handler.*/
int (* unlink)(const char *path);
} OCPersistentStorage;
+/**
+ * Possible returned values from entity handler.
+ */
typedef struct
{
- // Action associated with observation request
+ /** Action associated with observation request.*/
OCObserveAction action;
- // Identifier for observation being registered/deregistered
+
+ /** Identifier for observation being registered/deregistered.*/
OCObservationId obsId;
} OCObservationInfo;
*/
typedef struct OCHeaderOption
{
- // The protocol ID this option applies to
+ /** The protocol ID this option applies to.*/
OCTransportProtocolID protocolID;
- // The header option ID which will be added to communication packets
+
+ /** The header option ID which will be added to communication packets.*/
uint16_t optionID;
- // its length 191
+
+ /** its length 191.*/
uint16_t optionLength;
- // pointer to its data
+
+ /** pointer to its data.*/
uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
-#ifdef __cplusplus
+#ifdef SUPPORTS_DEFAULT_CTOR
OCHeaderOption() = default;
OCHeaderOption(OCTransportProtocolID pid,
uint16_t optId,
#endif
} OCHeaderOption;
+
/**
- * This structure describes the platform properties. All non-Null properties will be included
- * in a platform discovery request.
+ * This structure describes the platform properties. All non-Null properties will be
+ * included in a platform discovery request.
*/
typedef struct
{
+ /** Platform ID.*/
char *platformID;
+
+ /** Manufacturer name.*/
char *manufacturerName;
+
+ /** Manufacturer URL for platform property.*/
char *manufacturerUrl;
+
+ /** Model number.*/
char *modelNumber;
+
+ /** Manufacturer date.*/
char *dateOfManufacture;
+
+ /** Platform version.*/
char *platformVersion;
+
+ /** Operating system version.*/
char *operatingSystemVersion;
+
+ /** HW version.*/
char *hardwareVersion;
+
+ /** FW version.*/
char *firmwareVersion;
+
+ /** Platform support URL.*/
char *supportUrl;
+
+ /** System time.*/
char *systemTime;
} OCPlatformInfo;
+/**
+ * This structure is expected as input for device properties.
+ * device name is mandatory and expected from the application.
+ * device id of type UUID will be generated by the stack.
+ */
+typedef struct
+{
+ /** Pointer to the device name.*/
+ char *deviceName;
+
+} OCDeviceInfo;
+
#ifdef RA_ADAPTER
/**
- * @brief CA Remote Access information for XMPP Client
+ * CA Remote Access information for XMPP Client
*
*/
typedef struct
} OCRAInfo_t;
#endif /* RA_ADAPTER */
-/**
- * This structure is expected as input for device properties.
- * device name is mandatory and expected from the application.
- * device id of type UUID will be generated by the stack.
- */
-typedef struct
-{
- char *deviceName;
-
-} OCDeviceInfo;
-// Enum to describe the type of object held by the OCPayload object
+/** Enum to describe the type of object held by the OCPayload object.*/
typedef enum
{
PAYLOAD_TYPE_INVALID,
PAYLOAD_TYPE_PLATFORM,
PAYLOAD_TYPE_REPRESENTATION,
PAYLOAD_TYPE_SECURITY,
- PAYLOAD_TYPE_PRESENCE
+ PAYLOAD_TYPE_PRESENCE,
+ PAYLOAD_TYPE_RD
} OCPayloadType;
typedef struct
struct OCResourcePayload* next;
} OCResourcePayload;
+/**
+ * Structure holding Links Payload. It is a sub-structure used in
+ * OCResourceCollectionPayload.
+ */
+typedef struct OCLinksPayload
+{
+ /** This is the target relative URI. */
+ char *href;
+ /** Resource Type - A standard OIC specified or vendor defined resource
+ * type of the resource referenced by the target URI. */
+ OCStringLL *rt;
+ /** Interface - The interfaces supported by the resource referenced by the target URI. */
+ OCStringLL *itf;
+ /** The relation of the target URI referenced by the link to the context URI;
+ * The default value is null. */
+ char *rel;
+ /** Specifies if the resource referenced by the target URIis observable or not. */
+ bool obs;
+ /** A title for the link relation. Can be used by the UI to provide a context. */
+ char *title;
+ /** This is used to override the context URI e.g. override the URI of the containing collection. */
+ char *uri;
+ /** The instance identifier for this web link in an array of web links - used in links. */
+ union
+ {
+ /** An ordinal number that is not repeated - must be unique in the collection context. */
+ uint8_t ins;
+ /** Any unique string including a URI. */
+ char *uniqueStr;
+ /** Use UUID for universal uniqueness - used in /oic/res to identify the device. */
+ OCIdentity uniqueUUID;
+ };
+ /** A hint of the media type of the representation of the resource referenced by the target URI. */
+ OCStringLL *mt;
+ /** Holding address of the next resource. */
+ struct OCLinksPayload *next;
+} OCLinksPayload;
+
+/** Structure holding tags value of the links payload. */
+typedef struct
+{
+ /** Name of tags. */
+ OCDeviceInfo n;
+ /** Device identifier. */
+ OCIdentity di;
+ /** The base URI where the resources are hold. */
+ char *baseURI;
+ /** Bitmap holds observable, discoverable, secure option flag.*/
+ uint8_t bitmap;
+ /** Port set in case, the secure flag is set above. */
+ uint16_t port;
+ /** Id for each set of links i.e. tag. */
+ union
+ {
+ /** An ordinal number that is not repeated - must be unique in the collection context. */
+ uint8_t ins;
+ /** Any unique string including a URI. */
+ char *uniqueStr;
+ /** Use UUID for universal uniqueness - used in /oic/res to identify the device. */
+ OCIdentity uniqueUUID;
+ };
+ /** Defines the list of allowable resource types (for Target and anchors) in links included
+ * in the collection; new links being created can only be from this list. */
+ char *rts;
+ /** When specified this is the default relationship to use when an OIC Link does not specify
+ * an explicit relationship with *rel* parameter. */
+ char *drel;
+ /** Time to keep holding resource.*/
+ uint32_t ttl;
+} OCTagsPayload;
+
+/** Resource collection payload. */
+typedef struct OCResourceCollectionPayload
+{
+ /** Collection tags payload.*/
+ OCTagsPayload *tags;
+ /** Array of links payload. */
+ OCLinksPayload *setLinks;
+ /** Holding address of the next resource. */
+ struct OCResourceCollectionPayload *next;
+} OCResourceCollectionPayload;
+
typedef struct
{
OCPayload base;
- OCResourcePayload* resources;
+ /** This structure holds the old /oic/res response. */
+ OCResourcePayload *resources;
+ /** This structure holds the collection response for the /oic/res. */
+ OCResourceCollectionPayload *collectionResources;
} OCDiscoveryPayload;
+/**
+ * Structure holding discovery payload.
+ */
+typedef struct
+{
+ /** Device Name. */
+ OCDeviceInfo n;
+ /** Device Identity. */
+ OCIdentity di;
+ /** Value holding the bias factor of the RD. */
+ uint8_t sel;
+} OCRDDiscoveryPayload;
+
+/**
+ * RD Payload that will be transmitted over the wire.
+ */
+typedef struct
+{
+ OCPayload base;
+ /** Pointer to the discovery response payload.*/
+ OCRDDiscoveryPayload *rdDiscovery;
+ /** Pointer to the publish payload.*/
+ OCResourceCollectionPayload *rdPublish;
+} OCRDPayload;
+
typedef struct
{
OCPayload base;
/**
* Incoming requests handled by the server. Requests are passed in as a parameter to the
- * @ref OCEntityHandler callback API.
- * @brief The @ref OCEntityHandler callback API must be implemented in the application in order
+ * OCEntityHandler callback API.
+ * The OCEntityHandler callback API must be implemented in the application in order
* to receive these requests.
*/
typedef struct
{
- // Associated resource
+ /** Associated resource.*/
OCResourceHandle resource;
+
+ /** Associated request handle.*/
OCRequestHandle requestHandle;
- // the REST method retrieved from received request PDU
+
+ /** the REST method retrieved from received request PDU.*/
OCMethod method;
- // description of endpoint that sent the request
+
+ /** description of endpoint that sent the request.*/
OCDevAddr devAddr;
- // resource query send by client
+
+ /** resource query send by client.*/
char * query;
- // Information associated with observation - valid only when OCEntityHandler
- // flag includes OC_OBSERVE_FLAG
+
+ /** Information associated with observation - valid only when OCEntityHandler flag includes
+ * ::OC_OBSERVE_FLAG.*/
OCObservationInfo obsInfo;
- // An array of the received vendor specific header options
+
+ /** Number of the received vendor specific header options.*/
uint8_t numRcvdVendorSpecificHeaderOptions;
+
+ /** Pointer to the array of the received vendor specific header options.*/
OCHeaderOption * rcvdVendorSpecificHeaderOptions;
- // the payload from the request PDU
+
+ /** the payload from the request PDU.*/
OCPayload *payload;
+
} OCEntityHandlerRequest;
+
/**
- * Response from queries to remote servers. Queries are made by calling the @ref OCDoResource API.
+ * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
*/
typedef struct
{
- /// Address of remote server
+ /** Address of remote server.*/
OCDevAddr devAddr;
- OCDevAddr *addr; // backward compatibility (points to devAddr)
- OCConnectivityType connType; // backward compatibility
- /// the is the result of our stack, OCStackResult should contain coap/other error codes;
+
+ /** backward compatibility (points to devAddr).*/
+ OCDevAddr *addr;
+
+ /** backward compatibility.*/
+ OCConnectivityType connType;
+
+ /** the security identity of the remote server.*/
+ OCIdentity identity;
+
+ /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
OCStackResult result;
- /// If associated with observe, this will represent the sequence of notifications from server.
+
+ /** If associated with observe, this will represent the sequence of notifications from server.*/
uint32_t sequenceNumber;
- /// resourceURI
+
+ /** resourceURI.*/
const char * resourceUri;
- // the payload for the response PDU
+
+ /** the payload for the response PDU.*/
OCPayload *payload;
- /// An array of the received vendor specific header options
+
+ /** Number of the received vendor specific header options.*/
uint8_t numRcvdVendorSpecificHeaderOptions;
+
+ /** An array of the received vendor specific header options.*/
OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
} OCClientResponse;
+/**
+ * Request handle is passed to server via the entity handler for each incoming request.
+ * Stack assigns when request is received, server sets to indicate what request response is for.
+ */
typedef struct
{
- // Request handle is passed to server via the entity handler for each incoming request.
- // Stack assigns when request is received, server sets to indicate what request response is for
+ /** Request handle.*/
OCRequestHandle requestHandle;
- // Resource handle
+
+ /** Resource handle.*/
OCResourceHandle resourceHandle;
- // Allow the entity handler to pass a result with the response
+
+ /** Allow the entity handler to pass a result with the response.*/
OCEntityHandlerResult ehResult;
- // this is the pointer to server payload data to be transferred
+
+ /** This is the pointer to server payload data to be transferred.*/
OCPayload* payload;
- // An array of the vendor specific header options the entity handler wishes to use in response
+
+ /** number of the vendor specific header options .*/
uint8_t numSendVendorSpecificHeaderOptions;
+
+ /** An array of the vendor specific header options the entity handler wishes to use in response.*/
OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
- // URI of new resource that entity handler might create
+
+ /** URI of new resource that entity handler might create.*/
char resourceUri[MAX_URI_LENGTH];
- // Server sets to true for persistent response buffer, false for non-persistent response buffer
+
+ /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
uint8_t persistentBufferFlag;
} OCEntityHandlerResponse;
+/**
+ * Entity's state
+ */
typedef enum
{
+ /** Request state.*/
OC_REQUEST_FLAG = (1 << 1),
+ /** Observe state.*/
OC_OBSERVE_FLAG = (1 << 2)
-} OCEntityHandlerFlag; //entity_handler_flag_t ;
+} OCEntityHandlerFlag;
/**
* Possible returned values from client application.
*/
typedef enum
{
- OC_STACK_DELETE_TRANSACTION = 0,//!< OC_STACK_DELETE_TRANSACTION
- OC_STACK_KEEP_TRANSACTION //!< OC_STACK_KEEP_TRANSACTION
+ OC_STACK_DELETE_TRANSACTION = 0,
+ OC_STACK_KEEP_TRANSACTION
} OCStackApplicationResult;
-//-----------------------------------------------------------------------------
-// Callback function definitions
-//-----------------------------------------------------------------------------
+
+/*
+ * -------------------------------------------------------------------------------------------
+ * Callback function definitions
+ * -------------------------------------------------------------------------------------------
+ */
/**
* Client applications implement this callback to consume responses received from Servers.
*/
typedef struct OCCallbackData
{
+ /** Pointer to the context.*/
void *context;
- /// The pointer to a function the stack will call to handle the requests
+
+ /** The pointer to a function the stack will call to handle the requests.*/
OCClientResponseHandler cb;
- /// A pointer to a function to delete the context when this callback is removed
+
+ /** A pointer to a function to delete the context when this callback is removed.*/
OCClientContextDeleter cd;
-#ifdef __cplusplus
+
+#ifdef SUPPORTS_DEFAULT_CTOR
OCCallbackData() = default;
OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
:context(ctx), cb(callback), cd(deleter){}
projects / platform / upstream / iotivity.git / blobdiff