1 //******************************************************************
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
19 //******************************************************************
25 * This file contains the definition, types and APIs for resource(s) be implemented.
31 #include "platform_features.h"
32 #include "ocstackconfig.h"
42 /** For the feature presence.*/
45 #include "ocpresence.h"
46 //-----------------------------------------------------------------------------
48 //-----------------------------------------------------------------------------
51 * OIC Virtual resources supported by every OIC device.
54 * Default discovery mechanism using '/oic/res' is supported by all OIC devices
55 * That are Discoverable.
57 #define OC_RSRVD_WELL_KNOWN_URI "/oic/res"
60 #define OC_RSRVD_DEVICE_URI "/oic/d"
63 #define OC_RSRVD_PLATFORM_URI "/oic/p"
66 #define OC_RSRVD_RESOURCE_TYPES_URI "/oic/res/types/d"
67 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
69 #define OC_RSRVD_GATEWAY_URI "/oic/gateway"
73 /** Presence URI through which the OIC devices advertise their presence.*/
74 #define OC_RSRVD_PRESENCE_URI "/oic/ad"
76 /** Sets the default time to live (TTL) for presence.*/
77 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
79 /** For multicast Discovery mechanism.*/
80 #define OC_MULTICAST_DISCOVERY_URI "/oic/res"
82 /** Separator for multiple query string.*/
83 #define OC_QUERY_SEPARATOR "&;"
86 * OC_DEFAULT_PRESENCE_TTL_SECONDS sets the default time to live (TTL) for presence.
88 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
91 * OC_MAX_PRESENCE_TTL_SECONDS sets the maximum time to live (TTL) for presence.
92 * NOTE: Changing the setting to a longer duration may lead to unsupported and untested
94 * 60 sec/min * 60 min/hr * 24 hr/day
96 #define OC_MAX_PRESENCE_TTL_SECONDS (60 * 60 * 24)
100 * Presence "Announcement Triggers".
104 #define OC_RSRVD_TRIGGER_CREATE "create"
107 #define OC_RSRVD_TRIGGER_CHANGE "change"
110 #define OC_RSRVD_TRIGGER_DELETE "delete"
113 * Attributes used to form a proper OIC conforming JSON message.
116 #define OC_RSRVD_OC "oic"
120 #define OC_RSRVD_PAYLOAD "payload"
122 /** To represent href */
123 #define OC_RSRVD_HREF "href"
125 /** To represent property*/
126 #define OC_RSRVD_PROPERTY "prop"
128 /** For representation.*/
129 #define OC_RSRVD_REPRESENTATION "rep"
131 /** To represent content type.*/
132 #define OC_RSRVD_CONTENT_TYPE "ct"
134 /** To represent resource type.*/
135 #define OC_RSRVD_RESOURCE_TYPE "rt"
137 /** To represent resource type with presence.*/
138 #define OC_RSRVD_RESOURCE_TYPE_PRESENCE "oic.wk.ad"
140 /** To represent resource type with device.*/
141 #define OC_RSRVD_RESOURCE_TYPE_DEVICE "oic.wk.d"
143 /** To represent resource type with platform.*/
144 #define OC_RSRVD_RESOURCE_TYPE_PLATFORM "oic.wk.p"
146 /** To represent interface.*/
147 #define OC_RSRVD_INTERFACE "if"
149 /** To represent time to live.*/
150 #define OC_RSRVD_TTL "ttl"
152 /** To represent non*/
153 #define OC_RSRVD_NONCE "non"
155 /** To represent trigger type.*/
156 #define OC_RSRVD_TRIGGER "trg"
158 /** To represent links.*/
159 #define OC_RSRVD_LINKS "links"
161 /** To represent default interface.*/
162 #define OC_RSRVD_INTERFACE_DEFAULT "oic.if.baseline"
164 /** To represent read-only interface.*/
165 #define OC_RSRVD_INTERFACE_READ "oic.if.r"
167 /** To represent ll interface.*/
168 #define OC_RSRVD_INTERFACE_LL "oic.if.ll"
170 /** To represent batch interface.*/
171 #define OC_RSRVD_INTERFACE_BATCH "oic.if.b"
173 /** To represent interface group.*/
174 #define OC_RSRVD_INTERFACE_GROUP "oic.mi.grp"
176 /** To represent MFG date.*/
177 #define OC_RSRVD_MFG_DATE "mndt"
179 /** To represent FW version.*/
180 #define OC_RSRVD_FW_VERSION "mnfv"
182 /** To represent host name.*/
183 #define OC_RSRVD_HOST_NAME "hn"
185 /** To represent policy.*/
186 #define OC_RSRVD_POLICY "p"
188 /** To represent bitmap.*/
189 #define OC_RSRVD_BITMAP "bm"
192 #define OC_RSRVD_SECURE "sec"
195 #define OC_RSRVD_HOSTING_PORT "port"
197 /** For Server instance ID.*/
198 #define OC_RSRVD_SERVER_INSTANCE_ID "sid"
205 #define OC_RSRVD_PLATFORM_ID "pi"
207 /** Platform MFG NAME. */
208 #define OC_RSRVD_MFG_NAME "mnmn"
211 #define OC_RSRVD_MFG_URL "mnml"
214 #define OC_RSRVD_MODEL_NUM "mnmo"
216 /** Platform MFG Date.*/
217 #define OC_RSRVD_MFG_DATE "mndt"
219 /** Platform versio.n */
220 #define OC_RSRVD_PLATFORM_VERSION "mnpv"
222 /** Platform Operating system version. */
223 #define OC_RSRVD_OS_VERSION "mnos"
225 /** Platform Hardware version. */
226 #define OC_RSRVD_HARDWARE_VERSION "mnhw"
228 /**Platform Firmware version. */
229 #define OC_RSRVD_FIRMWARE_VERSION "mnfv"
231 /** Support URL for the platform. */
232 #define OC_RSRVD_SUPPORT_URL "mnsl"
234 /** System time for the platform. */
235 #define OC_RSRVD_SYSTEM_TIME "st"
242 #define OC_RSRVD_DEVICE_ID "di"
245 #define OC_RSRVD_DEVICE_NAME "n"
247 /** Device specification version.*/
248 #define OC_RSRVD_SPEC_VERSION "icv"
250 /** Device data model.*/
251 #define OC_RSRVD_DATA_MODEL_VERSION "dmv"
253 /** Device specification version.*/
254 #define OC_SPEC_VERSION "core.1.0.0"
256 /** Device Data Model version.*/
257 #define OC_DATA_MODEL_VERSION "res.1.0.0"
260 * These provide backward compatibility - their use is deprecated.
264 /** Multicast Prefix.*/
265 #define OC_MULTICAST_PREFIX "224.0.1.187:5683"
267 /** Multicast IP address.*/
268 #define OC_MULTICAST_IP "224.0.1.187"
270 /** Multicast Port.*/
271 #define OC_MULTICAST_PORT 5683
274 /** Max Device address size. */
276 #define MAX_ADDR_STR_SIZE (256)
278 /** Max Address could be "coaps://[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]:xxxxx */
279 #define MAX_ADDR_STR_SIZE (56)
282 /** Max identity size. */
283 #define MAX_IDENTITY_SIZE (32)
285 /** Universal unique identity size. */
286 #define UUID_IDENTITY_SIZE (128/8)
288 /** Resource Directory */
290 /** Resource Directory URI used to Discover RD and Publish resources.*/
291 #define OC_RSRVD_RD_URI "/oic/rd"
293 /** To represent resource type with rd.*/
294 #define OC_RSRVD_RESOURCE_TYPE_RD "oic.wk.rd"
296 /** RD Discovery bias factor type. */
297 #define OC_RSRVD_RD_DISCOVERY_SEL "sel"
300 #define OC_RSRVD_BASE_URI "baseURI"
302 /** Unique value per collection/link. */
303 #define OC_RSRVD_INS "ins"
305 /** Allowable resource types in the links. */
306 #define OC_RSRVD_RTS "rts"
308 /** Default relationship. */
309 #define OC_RSRVD_DREL "drel"
311 /** Defines relationship between links. */
312 #define OC_RSRVD_REL "rel"
314 /** Defines title. */
315 #define OC_RSRVD_TITLE "title"
318 #define OC_RSRVD_URI "uri"
320 /** Defines media type. */
321 #define OC_RSRVD_MEDIA_TYPE "mt"
323 /** To represent resource type with Publish RD.*/
324 #define OC_RSRVD_RESOURCE_TYPE_RDPUBLISH "oic.wk.rdPub"
327 * These enums (OCTransportAdapter and OCTransportFlags) must
328 * be kept synchronized with OCConnectivityType (below) as well as
329 * CATransportAdapter and CATransportFlags (in CACommon.h).
333 /** value zero indicates discovery.*/
334 OC_DEFAULT_ADAPTER = 0,
336 /** IPv4 and IPv6, including 6LoWPAN.*/
337 OC_ADAPTER_IP = (1 << 0),
339 /** GATT over Bluetooth LE.*/
340 OC_ADAPTER_GATT_BTLE = (1 << 1),
342 /** RFCOMM over Bluetooth EDR.*/
343 OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
345 /**Remote Access over XMPP.*/
346 OC_ADAPTER_REMOTE_ACCESS = (1 << 3),
349 OC_ADAPTER_TCP = (1 << 4),
351 /** NFC Transport for Messaging.*/
352 OC_ADAPTER_NFC = (1 << 5)
353 } OCTransportAdapter;
356 * Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
360 /** default flag is 0*/
361 OC_DEFAULT_FLAGS = 0,
363 /** Insecure transport is the default (subject to change).*/
364 /** secure the transport path*/
365 OC_FLAG_SECURE = (1 << 4),
367 /** IPv4 & IPv6 auto-selection is the default.*/
368 /** IP adapter only.*/
369 OC_IP_USE_V6 = (1 << 5),
371 /** IP adapter only.*/
372 OC_IP_USE_V4 = (1 << 6),
374 /** internal use only.*/
375 OC_RESERVED1 = (1 << 7), // internal use only
377 /** Link-Local multicast is the default multicast scope for IPv6.
378 * These are placed here to correspond to the IPv6 multicast address bits.*/
380 /** IPv6 Interface-Local scope (loopback).*/
381 OC_SCOPE_INTERFACE = 0x1,
383 /** IPv6 Link-Local scope (default).*/
386 /** IPv6 Realm-Local scope. */
387 OC_SCOPE_REALM = 0x3,
389 /** IPv6 Admin-Local scope. */
390 OC_SCOPE_ADMIN = 0x4,
392 /** IPv6 Site-Local scope. */
395 /** IPv6 Organization-Local scope. */
398 /**IPv6 Global scope. */
399 OC_SCOPE_GLOBAL = 0xE,
403 /** Bit mask for scope.*/
404 #define OC_MASK_SCOPE (0x000F)
406 /** Bit mask for Mods.*/
407 #define OC_MASK_MODS (0x0FF0)
408 #define OC_MASK_FAMS (OC_IP_USE_V6|OC_IP_USE_V4)
411 * End point identity.
415 /** Identity Length */
418 /** Array of end point identity.*/
419 unsigned char id[MAX_IDENTITY_SIZE];
423 * Universally unique identifier.
427 /** identitifier string.*/
428 unsigned char id[UUID_IDENTITY_SIZE];
432 * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
433 * OCDevAddr must be the same as CAEndpoint (in CACommon.h).
438 OCTransportAdapter adapter;
440 /** transport modifiers.*/
441 OCTransportFlags flags;
446 /** address for all adapters.*/
447 char addr[MAX_ADDR_STR_SIZE];
449 /** usually zero for default interface.*/
451 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
452 char routeData[MAX_ADDR_STR_SIZE]; //destination GatewayID:ClientId
457 * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
458 * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
459 * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
462 * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
466 /** use when defaults are ok. */
469 /** IPv4 and IPv6, including 6LoWPAN.*/
470 CT_ADAPTER_IP = (1 << 16),
472 /** GATT over Bluetooth LE.*/
473 CT_ADAPTER_GATT_BTLE = (1 << 17),
475 /** RFCOMM over Bluetooth EDR.*/
476 CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
479 /** Remote Access over XMPP.*/
480 CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
483 CT_ADAPTER_TCP = (1 << 20),
486 CT_ADAPTER_NFC = (1 << 21),
488 /** Insecure transport is the default (subject to change).*/
490 /** secure the transport path.*/
491 CT_FLAG_SECURE = (1 << 4),
493 /** IPv4 & IPv6 autoselection is the default.*/
495 /** IP adapter only.*/
496 CT_IP_USE_V6 = (1 << 5),
498 /** IP adapter only.*/
499 CT_IP_USE_V4 = (1 << 6),
501 /** Link-Local multicast is the default multicast scope for IPv6.
502 * These are placed here to correspond to the IPv6 address bits.*/
504 /** IPv6 Interface-Local scope(loopback).*/
505 CT_SCOPE_INTERFACE = 0x1,
507 /** IPv6 Link-Local scope (default).*/
510 /** IPv6 Realm-Local scope.*/
511 CT_SCOPE_REALM = 0x3,
513 /** IPv6 Admin-Local scope.*/
514 CT_SCOPE_ADMIN = 0x4,
516 /** IPv6 Site-Local scope.*/
519 /** IPv6 Organization-Local scope.*/
522 /** IPv6 Global scope.*/
523 CT_SCOPE_GLOBAL = 0xE,
524 } OCConnectivityType;
526 /** bit shift required for connectivity adapter.*/
527 #define CT_ADAPTER_SHIFT 16
530 #define CT_MASK_FLAGS 0xFFFF
533 #define CT_MASK_ADAPTER 0xFFFF0000
536 * OCDoResource methods to dispatch the request
540 OC_REST_NOMETHOD = 0,
543 OC_REST_GET = (1 << 0),
546 OC_REST_PUT = (1 << 1),
549 OC_REST_POST = (1 << 2),
552 OC_REST_DELETE = (1 << 3),
554 /** Register observe request for most up date notifications ONLY.*/
555 OC_REST_OBSERVE = (1 << 4),
557 /** Register observe request for all notifications, including stale notifications.*/
558 OC_REST_OBSERVE_ALL = (1 << 5),
560 /** De-register observation, intended for internal use.*/
561 OC_REST_CANCEL_OBSERVE = (1 << 6),
564 /** Subscribe for all presence notifications of a particular resource.*/
565 OC_REST_PRESENCE = (1 << 7),
568 /** Allows OCDoResource caller to do discovery.*/
569 OC_REST_DISCOVER = (1 << 8)
573 * Formats for payload encoding.
579 OC_FORMAT_UNSUPPORTED,
583 * Host Mode of Operation.
590 OC_GATEWAY /**< Client server mode along with routing capabilities.*/
594 * Quality of Service attempts to abstract the guarantees provided by the underlying transport
595 * protocol. The precise definitions of each quality of service level depend on the
596 * implementation. In descriptions below are for the current implementation and may changed
601 /** Packet delivery is best effort.*/
604 /** Packet delivery is best effort.*/
607 /** Acknowledgments are used to confirm delivery.*/
610 /** No Quality is defined, let the stack decide.*/
612 } OCQualityOfService;
615 * Resource Properties.
616 * The value of a policy property is defined as bitmap.
617 * The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
618 * Not including the policy property is equivalent to zero.
623 /** When none of the bits are set, the resource is non-discoverable &
624 * non-observable by the client.*/
625 OC_RES_PROP_NONE = (0),
627 /** When this bit is set, the resource is allowed to be discovered by clients.*/
628 OC_DISCOVERABLE = (1 << 0),
630 /** When this bit is set, the resource is allowed to be observed by clients.*/
631 OC_OBSERVABLE = (1 << 1),
633 /** When this bit is set, the resource is initialized, otherwise the resource
634 * is 'inactive'. 'inactive' signifies that the resource has been marked for
635 * deletion or is already deleted.*/
636 OC_ACTIVE = (1 << 2),
638 /** When this bit is set, the resource has been marked as 'slow'.
639 * 'slow' signifies that responses from this resource can expect delays in
640 * processing its requests from clients.*/
643 /** When this bit is set, the resource is a secure resource.*/
644 OC_SECURE = (1 << 4),
646 /** When this bit is set, the resource is allowed to be discovered only
647 * if discovery request contains an explicit querystring.
648 * Ex: GET /oic/res?rt=oic.sec.acl */
649 OC_EXPLICIT_DISCOVERABLE = (1 << 5)
650 } OCResourceProperty;
653 * Transport Protocol IDs.
657 /** For invalid ID.*/
658 OC_INVALID_ID = (1 << 0),
661 OC_COAP_ID = (1 << 1)
662 } OCTransportProtocolID;
665 * Declares Stack Results & Errors.
669 /** Success status code - START HERE.*/
671 OC_STACK_RESOURCE_CREATED,
672 OC_STACK_RESOURCE_DELETED,
674 /** Success status code - END HERE.*/
676 /** Error status code - START HERE.*/
677 OC_STACK_INVALID_URI = 20,
678 OC_STACK_INVALID_QUERY,
680 OC_STACK_INVALID_PORT,
681 OC_STACK_INVALID_CALLBACK,
682 OC_STACK_INVALID_METHOD,
684 /** Invalid parameter.*/
685 OC_STACK_INVALID_PARAM,
686 OC_STACK_INVALID_OBSERVE_PARAM,
690 OC_STACK_ADAPTER_NOT_ENABLED,
693 /** Resource not found.*/
694 OC_STACK_NO_RESOURCE,
696 /** e.g: not supported method or interface.*/
697 OC_STACK_RESOURCE_ERROR,
698 OC_STACK_SLOW_RESOURCE,
699 OC_STACK_DUPLICATE_REQUEST,
701 /** Resource has no registered observers.*/
702 OC_STACK_NO_OBSERVERS,
703 OC_STACK_OBSERVER_NOT_FOUND,
704 OC_STACK_VIRTUAL_DO_NOT_HANDLE,
705 OC_STACK_INVALID_OPTION,
707 /** The remote reply contained malformed data.*/
708 OC_STACK_MALFORMED_RESPONSE,
709 OC_STACK_PERSISTENT_BUFFER_REQUIRED,
710 OC_STACK_INVALID_REQUEST_HANDLE,
711 OC_STACK_INVALID_DEVICE_INFO,
712 OC_STACK_INVALID_JSON,
714 /** Request is not authorized by Resource Server. */
715 OC_STACK_UNAUTHORIZED_REQ,
717 /** Error code from PDM */
718 OC_STACK_PDM_IS_NOT_INITIALIZED,
719 OC_STACK_DUPLICATE_UUID,
720 OC_STACK_INCONSISTENT_DB,
723 * Error code from OTM
724 * This error is plused from DTLS interface when handshake failure happens
726 OC_STACK_AUTHENTICATION_FAILURE,
728 /** Insert all new error codes here!.*/
730 OC_STACK_PRESENCE_STOPPED = 128,
731 OC_STACK_PRESENCE_TIMEOUT,
732 OC_STACK_PRESENCE_DO_NOT_HANDLE,
734 /** ERROR in stack.*/
736 /** Error status code - END HERE.*/
740 * Handle to an OCDoResource invocation.
742 typedef void * OCDoHandle;
745 * Handle to an OCResource object owned by the OCStack.
747 typedef void * OCResourceHandle;
750 * Handle to an OCRequest object owned by the OCStack.
752 typedef void * OCRequestHandle;
755 * Unique identifier for each observation request. Used when observations are
756 * registered or de-registered. Used by entity handler to signal specific
757 * observers to be notified of resource changes.
758 * There can be maximum of 256 observations per server.
760 typedef uint8_t OCObservationId;
763 * Action associated with observation.
768 OC_OBSERVE_REGISTER = 0,
770 /** To Deregister. */
771 OC_OBSERVE_DEREGISTER = 1,
774 OC_OBSERVE_NO_OPTION = 2
779 * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
780 * when it calls OCRegisterPersistentStorageHandler.
781 * Persistent storage open handler points to default file path.
782 * Application can point to appropriate SVR database path for it's IoTivity Server.
785 /** Persistent storage file path.*/
786 FILE* (* open)(const char *path, const char *mode);
788 /** Persistent storage read handler.*/
789 size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
791 /** Persistent storage write handler.*/
792 size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
794 /** Persistent storage close handler.*/
795 int (* close)(FILE *fp);
797 /** Persistent storage unlink handler.*/
798 int (* unlink)(const char *path);
799 } OCPersistentStorage;
802 * Possible returned values from entity handler.
806 /** Action associated with observation request.*/
807 OCObserveAction action;
809 /** Identifier for observation being registered/deregistered.*/
810 OCObservationId obsId;
814 * Possible returned values from entity handler.
820 OC_EH_RESOURCE_CREATED,
821 OC_EH_RESOURCE_DELETED,
824 OC_EH_RESOURCE_NOT_FOUND
825 } OCEntityHandlerResult;
828 * This structure will be used to define the vendor specific header options to be included
829 * in communication packets.
831 typedef struct OCHeaderOption
833 /** The protocol ID this option applies to.*/
834 OCTransportProtocolID protocolID;
836 /** The header option ID which will be added to communication packets.*/
839 /** its length 191.*/
840 uint16_t optionLength;
842 /** pointer to its data.*/
843 uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
845 #ifdef SUPPORTS_DEFAULT_CTOR
846 OCHeaderOption() = default;
847 OCHeaderOption(OCTransportProtocolID pid,
850 const uint8_t* optData)
856 // parameter includes the null terminator.
857 optionLength = optionLength < MAX_HEADER_OPTION_DATA_LENGTH ?
858 optionLength : MAX_HEADER_OPTION_DATA_LENGTH;
859 memcpy(optionData, optData, optionLength);
860 optionData[optionLength - 1] = '\0';
867 * This structure describes the platform properties. All non-Null properties will be
868 * included in a platform discovery request.
875 /** Manufacturer name.*/
876 char *manufacturerName;
878 /** Manufacturer URL for platform property.*/
879 char *manufacturerUrl;
884 /** Manufacturer date.*/
885 char *dateOfManufacture;
887 /** Platform version.*/
888 char *platformVersion;
890 /** Operating system version.*/
891 char *operatingSystemVersion;
894 char *hardwareVersion;
897 char *firmwareVersion;
899 /** Platform support URL.*/
908 * This structure is expected as input for device properties.
909 * device name is mandatory and expected from the application.
910 * device id of type UUID will be generated by the stack.
914 /** Pointer to the device name.*/
921 * callback for bound JID
923 typedef void (*jid_bound_cb)(char *jid);
926 * CA Remote Access information for XMPP Client
931 char *hostname; /**< XMPP server hostname */
932 uint16_t port; /**< XMPP server serivce port */
933 char *xmpp_domain; /**< XMPP login domain */
934 char *username; /**< login username */
935 char *password; /**< login password */
936 char *resource; /**< specific resource for login */
937 char *user_jid; /**< specific JID for login */
938 jid_bound_cb jidbound; /**< callback when JID bound */
940 #endif /* RA_ADAPTER */
943 /** Enum to describe the type of object held by the OCPayload object.*/
946 PAYLOAD_TYPE_INVALID,
947 PAYLOAD_TYPE_DISCOVERY,
949 PAYLOAD_TYPE_PLATFORM,
950 PAYLOAD_TYPE_REPRESENTATION,
951 PAYLOAD_TYPE_SECURITY,
952 PAYLOAD_TYPE_PRESENCE,
958 // The type of message that was received
969 OCREP_PROP_BYTE_STRING,
972 }OCRepPayloadPropType;
974 /** This structure will be used to represent a binary string for CBOR payloads.*/
977 /** pointer to data bytes.*/
980 /** number of data bytes.*/
984 #define MAX_REP_ARRAY_DEPTH 3
987 OCRepPayloadPropType type;
988 size_t dimensions[MAX_REP_ARRAY_DEPTH];
997 /** pointer to ByteString array.*/
998 OCByteString* ocByteStrArray;
1000 struct OCRepPayload** objArray;
1002 } OCRepPayloadValueArray;
1004 typedef struct OCRepPayloadValue
1007 OCRepPayloadPropType type;
1015 /** ByteString object.*/
1016 OCByteString ocByteStr;
1018 struct OCRepPayload* obj;
1019 OCRepPayloadValueArray arr;
1021 struct OCRepPayloadValue* next;
1023 } OCRepPayloadValue;
1025 typedef struct OCStringLL
1027 struct OCStringLL *next;
1031 // used for get/set/put/observe/etc representations
1032 typedef struct OCRepPayload
1037 OCStringLL* interfaces;
1038 OCRepPayloadValue* values;
1039 struct OCRepPayload* next;
1042 // used inside a discovery payload
1043 typedef struct OCResourcePayload
1047 OCStringLL* interfaces;
1051 struct OCResourcePayload* next;
1052 } OCResourcePayload;
1055 * Structure holding Links Payload. It is a sub-structure used in
1056 * OCResourceCollectionPayload.
1058 typedef struct OCLinksPayload
1060 /** This is the target relative URI. */
1062 /** Resource Type - A standard OIC specified or vendor defined resource
1063 * type of the resource referenced by the target URI. */
1065 /** Interface - The interfaces supported by the resource referenced by the target URI. */
1067 /** The relation of the target URI referenced by the link to the context URI;
1068 * The default value is null. */
1070 /** Specifies if the resource referenced by the target URIis observable or not. */
1072 /** A title for the link relation. Can be used by the UI to provide a context. */
1074 /** This is used to override the context URI e.g. override the URI of the containing collection. */
1076 /** The instance identifier for this web link in an array of web links - used in links. */
1079 /** An ordinal number that is not repeated - must be unique in the collection context. */
1081 /** Any unique string including a URI. */
1083 /** Use UUID for universal uniqueness - used in /oic/res to identify the device. */
1084 OCIdentity uniqueUUID;
1086 /** A hint of the media type of the representation of the resource referenced by the target URI. */
1088 /** Holding address of the next resource. */
1089 struct OCLinksPayload *next;
1092 /** Structure holding tags value of the links payload. */
1095 /** Name of tags. */
1097 /** Device identifier. */
1099 /** The base URI where the resources are hold. */
1101 /** Bitmap holds observable, discoverable, secure option flag.*/
1103 /** Port set in case, the secure flag is set above. */
1105 /** Id for each set of links i.e. tag. */
1108 /** An ordinal number that is not repeated - must be unique in the collection context. */
1110 /** Any unique string including a URI. */
1112 /** Use UUID for universal uniqueness - used in /oic/res to identify the device. */
1113 OCIdentity uniqueUUID;
1115 /** Defines the list of allowable resource types (for Target and anchors) in links included
1116 * in the collection; new links being created can only be from this list. */
1118 /** When specified this is the default relationship to use when an OIC Link does not specify
1119 * an explicit relationship with *rel* parameter. */
1121 /** Time to keep holding resource.*/
1125 /** Resource collection payload. */
1126 typedef struct OCResourceCollectionPayload
1128 /** Collection tags payload.*/
1129 OCTagsPayload *tags;
1130 /** Array of links payload. */
1131 OCLinksPayload *setLinks;
1132 /** Holding address of the next resource. */
1133 struct OCResourceCollectionPayload *next;
1134 } OCResourceCollectionPayload;
1142 /** A special case for handling RD address. */
1145 /** This structure holds the old /oic/res response. */
1146 OCResourcePayload *resources;
1148 } OCDiscoveryPayload;
1151 * Structure holding discovery payload.
1157 /** Device Identity. */
1159 /** Value holding the bias factor of the RD. */
1161 } OCRDDiscoveryPayload;
1164 * RD Payload that will be transmitted over the wire.
1169 /** Pointer to the discovery response payload.*/
1170 OCRDDiscoveryPayload *rdDiscovery;
1171 /** Pointer to the publish payload.*/
1172 OCResourceCollectionPayload *rdPublish;
1181 char* dataModelVersion;
1188 OCPlatformInfo info;
1190 OCStringLL* interfaces;
1191 } OCPlatformPayload;
1197 } OCSecurityPayload;
1199 #ifdef WITH_PRESENCE
1203 uint32_t sequenceNumber;
1205 OCPresenceTrigger trigger;
1207 } OCPresencePayload;
1211 * Incoming requests handled by the server. Requests are passed in as a parameter to the
1212 * OCEntityHandler callback API.
1213 * The OCEntityHandler callback API must be implemented in the application in order
1214 * to receive these requests.
1218 /** Associated resource.*/
1219 OCResourceHandle resource;
1221 /** Associated request handle.*/
1222 OCRequestHandle requestHandle;
1224 /** the REST method retrieved from received request PDU.*/
1227 /** description of endpoint that sent the request.*/
1230 /** resource query send by client.*/
1233 /** Information associated with observation - valid only when OCEntityHandler flag includes
1234 * ::OC_OBSERVE_FLAG.*/
1235 OCObservationInfo obsInfo;
1237 /** Number of the received vendor specific header options.*/
1238 uint8_t numRcvdVendorSpecificHeaderOptions;
1240 /** Pointer to the array of the received vendor specific header options.*/
1241 OCHeaderOption * rcvdVendorSpecificHeaderOptions;
1243 /** the payload from the request PDU.*/
1246 } OCEntityHandlerRequest;
1250 * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
1254 /** Address of remote server.*/
1257 /** backward compatibility (points to devAddr).*/
1260 /** backward compatibility.*/
1261 OCConnectivityType connType;
1263 /** the security identity of the remote server.*/
1264 OCIdentity identity;
1266 /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
1267 OCStackResult result;
1269 /** If associated with observe, this will represent the sequence of notifications from server.*/
1270 uint32_t sequenceNumber;
1273 const char * resourceUri;
1275 /** the payload for the response PDU.*/
1278 /** Number of the received vendor specific header options.*/
1279 uint8_t numRcvdVendorSpecificHeaderOptions;
1281 /** An array of the received vendor specific header options.*/
1282 OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1286 * Request handle is passed to server via the entity handler for each incoming request.
1287 * Stack assigns when request is received, server sets to indicate what request response is for.
1291 /** Request handle.*/
1292 OCRequestHandle requestHandle;
1294 /** Resource handle.*/
1295 OCResourceHandle resourceHandle;
1297 /** Allow the entity handler to pass a result with the response.*/
1298 OCEntityHandlerResult ehResult;
1300 /** This is the pointer to server payload data to be transferred.*/
1303 /** number of the vendor specific header options .*/
1304 uint8_t numSendVendorSpecificHeaderOptions;
1306 /** An array of the vendor specific header options the entity handler wishes to use in response.*/
1307 OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1309 /** URI of new resource that entity handler might create.*/
1310 char resourceUri[MAX_URI_LENGTH];
1312 /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
1313 uint8_t persistentBufferFlag;
1314 } OCEntityHandlerResponse;
1321 /** Request state.*/
1322 OC_REQUEST_FLAG = (1 << 1),
1323 /** Observe state.*/
1324 OC_OBSERVE_FLAG = (1 << 2)
1325 } OCEntityHandlerFlag;
1328 * Possible returned values from client application.
1332 OC_STACK_DELETE_TRANSACTION = 0,
1333 OC_STACK_KEEP_TRANSACTION
1334 } OCStackApplicationResult;
1337 //#ifdef DIRECT_PAIRING
1339 * @brief direct pairing Method Type.
1341 * 1: pre-configured pin
1346 DP_NOT_ALLOWED = 0x0,
1347 DP_PRE_CONFIGURED = (0x1 << 0),
1348 DP_RANDOM_PIN = (0x1 << 1),
1352 * Device Information of discoverd direct pairing device(s).
1354 typedef struct OCDPDev
1357 OCConnectivityType connType;
1358 uint16_t securePort;
1362 OCUUIdentity deviceID;
1363 OCUUIdentity rowner;
1364 struct OCDPDev *next;
1366 //#endif // DIRECT_PAIRING
1369 * -------------------------------------------------------------------------------------------
1370 * Callback function definitions
1371 * -------------------------------------------------------------------------------------------
1375 * Client applications implement this callback to consume responses received from Servers.
1377 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
1378 OCClientResponse * clientResponse);
1381 * Client applications using a context pointer implement this callback to delete the
1382 * context upon removal of the callback/context pointer from the internal callback-list.
1384 typedef void (* OCClientContextDeleter)(void *context);
1387 * This info is passed from application to OC Stack when initiating a request to Server.
1389 typedef struct OCCallbackData
1391 /** Pointer to the context.*/
1394 /** The pointer to a function the stack will call to handle the requests.*/
1395 OCClientResponseHandler cb;
1397 /** A pointer to a function to delete the context when this callback is removed.*/
1398 OCClientContextDeleter cd;
1400 #ifdef SUPPORTS_DEFAULT_CTOR
1401 OCCallbackData() = default;
1402 OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
1403 :context(ctx), cb(callback), cd(deleter){}
1408 * Application server implementations must implement this callback to consume requests OTA.
1409 * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
1411 typedef OCEntityHandlerResult (*OCEntityHandler)
1412 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, void* callbackParam);
1415 * Device Entity handler need to use this call back instead of OCEntityHandler.
1417 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
1418 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri, void* callbackParam);
1420 //#ifdef DIRECT_PAIRING
1422 * Callback function definition of direct-pairing
1424 * @param[OUT] peer - pairing device info.
1425 * @param[OUT} result - It's returned with 'OC_STACK_XXX'. It will return 'OC_STACK_OK'
1426 * if D2D pairing is success without error
1428 typedef void (*OCDirectPairingCB)(OCDPDev_t *peer, OCStackResult result);
1429 //#endif // DIRECT_PAIRING
1433 #endif // __cplusplus
1435 #endif /* OCTYPES_H_ */