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 resource type with RES.*/
147 #define OC_RSRVD_RESOURCE_TYPE_RES "oic.wk.res"
149 /** To represent interface.*/
150 #define OC_RSRVD_INTERFACE "if"
152 /** To represent time to live.*/
153 #define OC_RSRVD_TTL "ttl"
155 /** To represent non*/
156 #define OC_RSRVD_NONCE "non"
158 /** To represent trigger type.*/
159 #define OC_RSRVD_TRIGGER "trg"
161 /** To represent links.*/
162 #define OC_RSRVD_LINKS "links"
164 /** To represent default interface.*/
165 #define OC_RSRVD_INTERFACE_DEFAULT "oic.if.baseline"
167 /** To represent read-only interface.*/
168 #define OC_RSRVD_INTERFACE_READ "oic.if.r"
170 /** To represent ll interface.*/
171 #define OC_RSRVD_INTERFACE_LL "oic.if.ll"
173 /** To represent batch interface.*/
174 #define OC_RSRVD_INTERFACE_BATCH "oic.if.b"
176 /** To represent interface group.*/
177 #define OC_RSRVD_INTERFACE_GROUP "oic.mi.grp"
179 /** To represent MFG date.*/
180 #define OC_RSRVD_MFG_DATE "mndt"
182 /** To represent FW version.*/
183 #define OC_RSRVD_FW_VERSION "mnfv"
185 /** To represent host name.*/
186 #define OC_RSRVD_HOST_NAME "hn"
188 /** To represent policy.*/
189 #define OC_RSRVD_POLICY "p"
191 /** To represent bitmap.*/
192 #define OC_RSRVD_BITMAP "bm"
195 #define OC_RSRVD_SECURE "sec"
198 #define OC_RSRVD_HOSTING_PORT "port"
200 /** For Server instance ID.*/
201 #define OC_RSRVD_SERVER_INSTANCE_ID "sid"
208 #define OC_RSRVD_PLATFORM_ID "pi"
210 /** Platform MFG NAME. */
211 #define OC_RSRVD_MFG_NAME "mnmn"
214 #define OC_RSRVD_MFG_URL "mnml"
217 #define OC_RSRVD_MODEL_NUM "mnmo"
219 /** Platform MFG Date.*/
220 #define OC_RSRVD_MFG_DATE "mndt"
222 /** Platform versio.n */
223 #define OC_RSRVD_PLATFORM_VERSION "mnpv"
225 /** Platform Operating system version. */
226 #define OC_RSRVD_OS_VERSION "mnos"
228 /** Platform Hardware version. */
229 #define OC_RSRVD_HARDWARE_VERSION "mnhw"
231 /**Platform Firmware version. */
232 #define OC_RSRVD_FIRMWARE_VERSION "mnfv"
234 /** Support URL for the platform. */
235 #define OC_RSRVD_SUPPORT_URL "mnsl"
237 /** System time for the platform. */
238 #define OC_RSRVD_SYSTEM_TIME "st"
245 #define OC_RSRVD_DEVICE_ID "di"
248 #define OC_RSRVD_DEVICE_NAME "n"
250 /** Device specification version.*/
251 #define OC_RSRVD_SPEC_VERSION "icv"
253 /** Device data model.*/
254 #define OC_RSRVD_DATA_MODEL_VERSION "dmv"
256 /** Device specification version.*/
257 #define OC_SPEC_VERSION "core.1.0.0"
259 /** Device Data Model version.*/
260 #define OC_DATA_MODEL_VERSION "res.1.0.0"
263 * These provide backward compatibility - their use is deprecated.
267 /** Multicast Prefix.*/
268 #define OC_MULTICAST_PREFIX "224.0.1.187:5683"
270 /** Multicast IP address.*/
271 #define OC_MULTICAST_IP "224.0.1.187"
273 /** Multicast Port.*/
274 #define OC_MULTICAST_PORT 5683
277 /** Max Device address size. */
279 #define MAX_ADDR_STR_SIZE (256)
281 /** Max Address could be "coap+tcp://[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]:xxxxx" */
282 #define MAX_ADDR_STR_SIZE (59)
285 /** Length of MAC address */
286 #define MAC_ADDR_STR_SIZE (17)
288 /** Blocks of MAC address */
289 #define MAC_ADDR_BLOCKS (6)
291 /** Max identity size. */
292 #define MAX_IDENTITY_SIZE (32)
294 /** Universal unique identity size. */
295 #define UUID_IDENTITY_SIZE (128/8)
297 /** Resource Directory */
299 /** Resource Directory URI used to Discover RD and Publish resources.*/
300 #define OC_RSRVD_RD_URI "/oic/rd"
302 /** To represent resource type with rd.*/
303 #define OC_RSRVD_RESOURCE_TYPE_RD "oic.wk.rd"
305 /** RD Discovery bias factor type. */
306 #define OC_RSRVD_RD_DISCOVERY_SEL "sel"
309 #define OC_RSRVD_BASE_URI "baseURI"
311 /** Unique value per collection/link. */
312 #define OC_RSRVD_INS "ins"
314 /** Allowable resource types in the links. */
315 #define OC_RSRVD_RTS "rts"
317 /** Default relationship. */
318 #define OC_RSRVD_DREL "drel"
320 /** Defines relationship between links. */
321 #define OC_RSRVD_REL "rel"
323 /** Defines title. */
324 #define OC_RSRVD_TITLE "title"
327 #define OC_RSRVD_URI "uri"
329 /** Defines media type. */
330 #define OC_RSRVD_MEDIA_TYPE "mt"
332 /** To represent resource type with Publish RD.*/
333 #define OC_RSRVD_RESOURCE_TYPE_RDPUBLISH "oic.wk.rdPub"
336 * Mark a parameter as unused. Used to prevent unused variable compiler warnings.
337 * Used in three cases:
338 * 1. in callbacks when one of the parameters are unused
339 * 2. when due to code changes a functions parameter is no longer
340 * used but must be left in place for backward compatibility
342 * 3. a variable is only used in the debug build variant and would
343 * give a build warning in release mode.
345 #define OC_UNUSED(x) (void)(x)
348 * These enums (OCTransportAdapter and OCTransportFlags) must
349 * be kept synchronized with OCConnectivityType (below) as well as
350 * CATransportAdapter and CATransportFlags (in CACommon.h).
354 /** value zero indicates discovery.*/
355 OC_DEFAULT_ADAPTER = 0,
357 /** IPv4 and IPv6, including 6LoWPAN.*/
358 OC_ADAPTER_IP = (1 << 0),
360 /** GATT over Bluetooth LE.*/
361 OC_ADAPTER_GATT_BTLE = (1 << 1),
363 /** RFCOMM over Bluetooth EDR.*/
364 OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
366 /**Remote Access over XMPP.*/
367 OC_ADAPTER_REMOTE_ACCESS = (1 << 3),
370 OC_ADAPTER_TCP = (1 << 4),
372 /** NFC Transport for Messaging.*/
373 OC_ADAPTER_NFC = (1 << 5)
374 } OCTransportAdapter;
377 * Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
381 /** default flag is 0*/
382 OC_DEFAULT_FLAGS = 0,
384 /** Insecure transport is the default (subject to change).*/
385 /** secure the transport path*/
386 OC_FLAG_SECURE = (1 << 4),
388 /** IPv4 & IPv6 auto-selection is the default.*/
389 /** IP adapter only.*/
390 OC_IP_USE_V6 = (1 << 5),
392 /** IP adapter only.*/
393 OC_IP_USE_V4 = (1 << 6),
395 /** internal use only.*/
396 OC_RESERVED1 = (1 << 7), // internal use only
398 /** Link-Local multicast is the default multicast scope for IPv6.
399 * These are placed here to correspond to the IPv6 multicast address bits.*/
401 /** IPv6 Interface-Local scope (loopback).*/
402 OC_SCOPE_INTERFACE = 0x1,
404 /** IPv6 Link-Local scope (default).*/
407 /** IPv6 Realm-Local scope. */
408 OC_SCOPE_REALM = 0x3,
410 /** IPv6 Admin-Local scope. */
411 OC_SCOPE_ADMIN = 0x4,
413 /** IPv6 Site-Local scope. */
416 /** IPv6 Organization-Local scope. */
419 /**IPv6 Global scope. */
420 OC_SCOPE_GLOBAL = 0xE,
424 /** Bit mask for scope.*/
425 #define OC_MASK_SCOPE (0x000F)
427 /** Bit mask for Mods.*/
428 #define OC_MASK_MODS (0x0FF0)
429 #define OC_MASK_FAMS (OC_IP_USE_V6|OC_IP_USE_V4)
431 typedef struct OCStringLL
433 struct OCStringLL *next;
438 * End point identity.
442 /** Identity Length */
445 /** Array of end point identity.*/
446 unsigned char id[MAX_IDENTITY_SIZE];
450 * Universally unique identifier.
454 /** identitifier string.*/
455 unsigned char id[UUID_IDENTITY_SIZE];
459 * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
460 * OCDevAddr must be the same as CAEndpoint (in CACommon.h).
465 OCTransportAdapter adapter;
467 /** transport modifiers.*/
468 OCTransportFlags flags;
473 /** address for all adapters.*/
474 char addr[MAX_ADDR_STR_SIZE];
476 /** usually zero for default interface.*/
478 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
479 char routeData[MAX_ADDR_STR_SIZE]; //destination GatewayID:ClientId
484 * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
485 * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
486 * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
489 * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
493 /** use when defaults are ok. */
496 /** IPv4 and IPv6, including 6LoWPAN.*/
497 CT_ADAPTER_IP = (1 << 16),
499 /** GATT over Bluetooth LE.*/
500 CT_ADAPTER_GATT_BTLE = (1 << 17),
502 /** RFCOMM over Bluetooth EDR.*/
503 CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
506 /** Remote Access over XMPP.*/
507 CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
510 CT_ADAPTER_TCP = (1 << 20),
513 CT_ADAPTER_NFC = (1 << 21),
515 /** Insecure transport is the default (subject to change).*/
517 /** secure the transport path.*/
518 CT_FLAG_SECURE = (1 << 4),
520 /** IPv4 & IPv6 autoselection is the default.*/
522 /** IP adapter only.*/
523 CT_IP_USE_V6 = (1 << 5),
525 /** IP adapter only.*/
526 CT_IP_USE_V4 = (1 << 6),
528 /** Link-Local multicast is the default multicast scope for IPv6.
529 * These are placed here to correspond to the IPv6 address bits.*/
531 /** IPv6 Interface-Local scope(loopback).*/
532 CT_SCOPE_INTERFACE = 0x1,
534 /** IPv6 Link-Local scope (default).*/
537 /** IPv6 Realm-Local scope.*/
538 CT_SCOPE_REALM = 0x3,
540 /** IPv6 Admin-Local scope.*/
541 CT_SCOPE_ADMIN = 0x4,
543 /** IPv6 Site-Local scope.*/
546 /** IPv6 Organization-Local scope.*/
549 /** IPv6 Global scope.*/
550 CT_SCOPE_GLOBAL = 0xE,
551 } OCConnectivityType;
553 /** bit shift required for connectivity adapter.*/
554 #define CT_ADAPTER_SHIFT 16
557 #define CT_MASK_FLAGS 0xFFFF
560 #define CT_MASK_ADAPTER 0xFFFF0000
563 * OCDoResource methods to dispatch the request
567 OC_REST_NOMETHOD = 0,
570 OC_REST_GET = (1 << 0),
573 OC_REST_PUT = (1 << 1),
576 OC_REST_POST = (1 << 2),
579 OC_REST_DELETE = (1 << 3),
581 /** Register observe request for most up date notifications ONLY.*/
582 OC_REST_OBSERVE = (1 << 4),
584 /** Register observe request for all notifications, including stale notifications.*/
585 OC_REST_OBSERVE_ALL = (1 << 5),
587 /** De-register observation, intended for internal use.*/
588 OC_REST_CANCEL_OBSERVE = (1 << 6),
591 /** Subscribe for all presence notifications of a particular resource.*/
592 OC_REST_PRESENCE = (1 << 7),
595 /** Allows OCDoResource caller to do discovery.*/
596 OC_REST_DISCOVER = (1 << 8)
600 * Formats for payload encoding.
606 OC_FORMAT_UNSUPPORTED,
610 * Host Mode of Operation.
617 OC_GATEWAY /**< Client server mode along with routing capabilities.*/
621 * Quality of Service attempts to abstract the guarantees provided by the underlying transport
622 * protocol. The precise definitions of each quality of service level depend on the
623 * implementation. In descriptions below are for the current implementation and may changed
628 /** Packet delivery is best effort.*/
631 /** Packet delivery is best effort.*/
634 /** Acknowledgments are used to confirm delivery.*/
637 /** No Quality is defined, let the stack decide.*/
639 } OCQualityOfService;
642 * Resource Properties.
643 * The value of a policy property is defined as bitmap.
644 * The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
645 * Not including the policy property is equivalent to zero.
650 /** When none of the bits are set, the resource is non-discoverable &
651 * non-observable by the client.*/
652 OC_RES_PROP_NONE = (0),
654 /** When this bit is set, the resource is allowed to be discovered by clients.*/
655 OC_DISCOVERABLE = (1 << 0),
657 /** When this bit is set, the resource is allowed to be observed by clients.*/
658 OC_OBSERVABLE = (1 << 1),
660 /** When this bit is set, the resource is initialized, otherwise the resource
661 * is 'inactive'. 'inactive' signifies that the resource has been marked for
662 * deletion or is already deleted.*/
663 OC_ACTIVE = (1 << 2),
665 /** When this bit is set, the resource has been marked as 'slow'.
666 * 'slow' signifies that responses from this resource can expect delays in
667 * processing its requests from clients.*/
670 /** When this bit is set, the resource is a secure resource.*/
671 OC_SECURE = (1 << 4),
673 /** When this bit is set, the resource is allowed to be discovered only
674 * if discovery request contains an explicit querystring.
675 * Ex: GET /oic/res?rt=oic.sec.acl */
676 OC_EXPLICIT_DISCOVERABLE = (1 << 5)
677 } OCResourceProperty;
680 * Transport Protocol IDs.
684 /** For invalid ID.*/
685 OC_INVALID_ID = (1 << 0),
688 OC_COAP_ID = (1 << 1)
689 } OCTransportProtocolID;
692 * Declares Stack Results & Errors.
696 /** Success status code - START HERE.*/
698 OC_STACK_RESOURCE_CREATED,
699 OC_STACK_RESOURCE_DELETED,
701 /** Success status code - END HERE.*/
703 /** Error status code - START HERE.*/
704 OC_STACK_INVALID_URI = 20,
705 OC_STACK_INVALID_QUERY,
707 OC_STACK_INVALID_PORT,
708 OC_STACK_INVALID_CALLBACK,
709 OC_STACK_INVALID_METHOD,
711 /** Invalid parameter.*/
712 OC_STACK_INVALID_PARAM,
713 OC_STACK_INVALID_OBSERVE_PARAM,
717 OC_STACK_ADAPTER_NOT_ENABLED,
720 /** Resource not found.*/
721 OC_STACK_NO_RESOURCE,
723 /** e.g: not supported method or interface.*/
724 OC_STACK_RESOURCE_ERROR,
725 OC_STACK_SLOW_RESOURCE,
726 OC_STACK_DUPLICATE_REQUEST,
728 /** Resource has no registered observers.*/
729 OC_STACK_NO_OBSERVERS,
730 OC_STACK_OBSERVER_NOT_FOUND,
731 OC_STACK_VIRTUAL_DO_NOT_HANDLE,
732 OC_STACK_INVALID_OPTION,
734 /** The remote reply contained malformed data.*/
735 OC_STACK_MALFORMED_RESPONSE,
736 OC_STACK_PERSISTENT_BUFFER_REQUIRED,
737 OC_STACK_INVALID_REQUEST_HANDLE,
738 OC_STACK_INVALID_DEVICE_INFO,
739 OC_STACK_INVALID_JSON,
741 /** Request is not authorized by Resource Server. */
742 OC_STACK_UNAUTHORIZED_REQ,
744 /** Error code from PDM */
745 OC_STACK_PDM_IS_NOT_INITIALIZED,
746 OC_STACK_DUPLICATE_UUID,
747 OC_STACK_INCONSISTENT_DB,
750 * Error code from OTM
751 * This error is plused from DTLS interface when handshake failure happens
753 OC_STACK_AUTHENTICATION_FAILURE,
755 /** Insert all new error codes here!.*/
757 OC_STACK_PRESENCE_STOPPED = 128,
758 OC_STACK_PRESENCE_TIMEOUT,
759 OC_STACK_PRESENCE_DO_NOT_HANDLE,
761 /** ERROR in stack.*/
763 /** Error status code - END HERE.*/
767 * Handle to an OCDoResource invocation.
769 typedef void * OCDoHandle;
772 * Handle to an OCResource object owned by the OCStack.
774 typedef void * OCResourceHandle;
777 * Handle to an OCRequest object owned by the OCStack.
779 typedef void * OCRequestHandle;
782 * Unique identifier for each observation request. Used when observations are
783 * registered or de-registered. Used by entity handler to signal specific
784 * observers to be notified of resource changes.
785 * There can be maximum of 256 observations per server.
787 typedef uint8_t OCObservationId;
790 * Action associated with observation.
795 OC_OBSERVE_REGISTER = 0,
797 /** To Deregister. */
798 OC_OBSERVE_DEREGISTER = 1,
801 OC_OBSERVE_NO_OPTION = 2
806 * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
807 * when it calls OCRegisterPersistentStorageHandler.
808 * Persistent storage open handler points to default file path.
809 * Application can point to appropriate SVR database path for it's IoTivity Server.
812 /** Persistent storage file path.*/
813 FILE* (* open)(const char *path, const char *mode);
815 /** Persistent storage read handler.*/
816 size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
818 /** Persistent storage write handler.*/
819 size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
821 /** Persistent storage close handler.*/
822 int (* close)(FILE *fp);
824 /** Persistent storage unlink handler.*/
825 int (* unlink)(const char *path);
826 } OCPersistentStorage;
829 * Possible returned values from entity handler.
833 /** Action associated with observation request.*/
834 OCObserveAction action;
836 /** Identifier for observation being registered/deregistered.*/
837 OCObservationId obsId;
841 * Possible returned values from entity handler.
847 OC_EH_RESOURCE_CREATED,
848 OC_EH_RESOURCE_DELETED,
851 OC_EH_RESOURCE_NOT_FOUND
852 } OCEntityHandlerResult;
855 * This structure will be used to define the vendor specific header options to be included
856 * in communication packets.
858 typedef struct OCHeaderOption
860 /** The protocol ID this option applies to.*/
861 OCTransportProtocolID protocolID;
863 /** The header option ID which will be added to communication packets.*/
866 /** its length 191.*/
867 uint16_t optionLength;
869 /** pointer to its data.*/
870 uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
872 #ifdef SUPPORTS_DEFAULT_CTOR
873 OCHeaderOption() = default;
874 OCHeaderOption(OCTransportProtocolID pid,
877 const uint8_t* optData)
883 // parameter includes the null terminator.
884 optionLength = optionLength < MAX_HEADER_OPTION_DATA_LENGTH ?
885 optionLength : MAX_HEADER_OPTION_DATA_LENGTH;
886 memcpy(optionData, optData, optionLength);
887 optionData[optionLength - 1] = '\0';
894 * This structure describes the platform properties. All non-Null properties will be
895 * included in a platform discovery request.
902 /** Manufacturer name.*/
903 char *manufacturerName;
905 /** Manufacturer URL for platform property.*/
906 char *manufacturerUrl;
911 /** Manufacturer date.*/
912 char *dateOfManufacture;
914 /** Platform version.*/
915 char *platformVersion;
917 /** Operating system version.*/
918 char *operatingSystemVersion;
921 char *hardwareVersion;
924 char *firmwareVersion;
926 /** Platform support URL.*/
935 * This structure is expected as input for device properties.
936 * device name is mandatory and expected from the application.
937 * device id of type UUID will be generated by the stack.
941 /** Pointer to the device name.*/
943 /** Pointer to the types.*/
949 * callback for bound JID
951 typedef void (*jid_bound_cb)(char *jid);
954 * CA Remote Access information for XMPP Client
959 char *hostname; /**< XMPP server hostname */
960 uint16_t port; /**< XMPP server serivce port */
961 char *xmpp_domain; /**< XMPP login domain */
962 char *username; /**< login username */
963 char *password; /**< login password */
964 char *resource; /**< specific resource for login */
965 char *user_jid; /**< specific JID for login */
966 jid_bound_cb jidbound; /**< callback when JID bound */
968 #endif /* RA_ADAPTER */
971 /** Enum to describe the type of object held by the OCPayload object.*/
974 PAYLOAD_TYPE_INVALID,
975 PAYLOAD_TYPE_DISCOVERY,
977 PAYLOAD_TYPE_PLATFORM,
978 PAYLOAD_TYPE_REPRESENTATION,
979 PAYLOAD_TYPE_SECURITY,
980 PAYLOAD_TYPE_PRESENCE,
986 // The type of message that was received
997 OCREP_PROP_BYTE_STRING,
1000 }OCRepPayloadPropType;
1002 /** This structure will be used to represent a binary string for CBOR payloads.*/
1005 /** pointer to data bytes.*/
1008 /** number of data bytes.*/
1012 #define MAX_REP_ARRAY_DEPTH 3
1015 OCRepPayloadPropType type;
1016 size_t dimensions[MAX_REP_ARRAY_DEPTH];
1025 /** pointer to ByteString array.*/
1026 OCByteString* ocByteStrArray;
1028 struct OCRepPayload** objArray;
1030 } OCRepPayloadValueArray;
1032 typedef struct OCRepPayloadValue
1035 OCRepPayloadPropType type;
1043 /** ByteString object.*/
1044 OCByteString ocByteStr;
1046 struct OCRepPayload* obj;
1047 OCRepPayloadValueArray arr;
1049 struct OCRepPayloadValue* next;
1051 } OCRepPayloadValue;
1053 // used for get/set/put/observe/etc representations
1054 typedef struct OCRepPayload
1059 OCStringLL* interfaces;
1060 OCRepPayloadValue* values;
1061 struct OCRepPayload* next;
1064 // used inside a discovery payload
1065 typedef struct OCResourcePayload
1069 OCStringLL* interfaces;
1073 struct OCResourcePayload* next;
1074 } OCResourcePayload;
1077 * Structure holding Links Payload. It is a sub-structure used in
1078 * OCResourceCollectionPayload.
1080 typedef struct OCLinksPayload
1082 /** This is the target relative URI. */
1084 /** Resource Type - A standard OIC specified or vendor defined resource
1085 * type of the resource referenced by the target URI. */
1087 /** Interface - The interfaces supported by the resource referenced by the target URI. */
1089 /** The relation of the target URI referenced by the link to the context URI;
1090 * The default value is null. */
1092 /** Specifies if the resource referenced by the target URIis observable or not. */
1094 /** A title for the link relation. Can be used by the UI to provide a context. */
1096 /** This is used to override the context URI e.g. override the URI of the containing collection. */
1098 /** The instance identifier for this web link in an array of web links - used in links. */
1101 /** An ordinal number that is not repeated - must be unique in the collection context. */
1103 /** Any unique string including a URI. */
1105 /** Use UUID for universal uniqueness - used in /oic/res to identify the device. */
1106 OCIdentity uniqueUUID;
1108 /** A hint of the media type of the representation of the resource referenced by the target URI. */
1110 /** Holding address of the next resource. */
1111 struct OCLinksPayload *next;
1114 /** Structure holding tags value of the links payload. */
1117 /** Name of tags. */
1119 /** Device identifier. */
1121 /** The base URI where the resources are hold. */
1123 /** Bitmap holds observable, discoverable, secure option flag.*/
1125 /** Port set in case, the secure flag is set above. */
1127 /** Id for each set of links i.e. tag. */
1130 /** An ordinal number that is not repeated - must be unique in the collection context. */
1132 /** Any unique string including a URI. */
1134 /** Use UUID for universal uniqueness - used in /oic/res to identify the device. */
1135 OCIdentity uniqueUUID;
1137 /** Defines the list of allowable resource types (for Target and anchors) in links included
1138 * in the collection; new links being created can only be from this list. */
1140 /** When specified this is the default relationship to use when an OIC Link does not specify
1141 * an explicit relationship with *rel* parameter. */
1143 /** Time to keep holding resource.*/
1147 /** Resource collection payload. */
1148 typedef struct OCResourceCollectionPayload
1150 /** Collection tags payload.*/
1151 OCTagsPayload *tags;
1152 /** Array of links payload. */
1153 OCLinksPayload *setLinks;
1154 /** Holding address of the next resource. */
1155 struct OCResourceCollectionPayload *next;
1156 } OCResourceCollectionPayload;
1165 /** A special case for handling RD address. */
1174 /** Resource Type */
1178 OCStringLL *interface;
1180 /** This structure holds the old /oic/res response. */
1181 OCResourcePayload *resources;
1183 } OCDiscoveryPayload;
1186 * Structure holding discovery payload.
1192 /** Device Identity. */
1194 /** Value holding the bias factor of the RD. */
1196 } OCRDDiscoveryPayload;
1199 * RD Payload that will be transmitted over the wire.
1204 /** Pointer to the discovery response payload.*/
1205 OCRDDiscoveryPayload *rdDiscovery;
1206 /** Pointer to the publish payload.*/
1207 OCResourceCollectionPayload *rdPublish;
1217 char* dataModelVersion;
1224 OCPlatformInfo info;
1226 OCStringLL* interfaces;
1227 } OCPlatformPayload;
1233 } OCSecurityPayload;
1234 #ifdef WITH_PRESENCE
1238 uint32_t sequenceNumber;
1240 OCPresenceTrigger trigger;
1242 } OCPresencePayload;
1246 * Incoming requests handled by the server. Requests are passed in as a parameter to the
1247 * OCEntityHandler callback API.
1248 * The OCEntityHandler callback API must be implemented in the application in order
1249 * to receive these requests.
1253 /** Associated resource.*/
1254 OCResourceHandle resource;
1256 /** Associated request handle.*/
1257 OCRequestHandle requestHandle;
1259 /** the REST method retrieved from received request PDU.*/
1262 /** description of endpoint that sent the request.*/
1265 /** resource query send by client.*/
1268 /** Information associated with observation - valid only when OCEntityHandler flag includes
1269 * ::OC_OBSERVE_FLAG.*/
1270 OCObservationInfo obsInfo;
1272 /** Number of the received vendor specific header options.*/
1273 uint8_t numRcvdVendorSpecificHeaderOptions;
1275 /** Pointer to the array of the received vendor specific header options.*/
1276 OCHeaderOption * rcvdVendorSpecificHeaderOptions;
1278 /** the payload from the request PDU.*/
1281 } OCEntityHandlerRequest;
1285 * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
1289 /** Address of remote server.*/
1292 /** backward compatibility (points to devAddr).*/
1295 /** backward compatibility.*/
1296 OCConnectivityType connType;
1298 /** the security identity of the remote server.*/
1299 OCIdentity identity;
1301 /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
1302 OCStackResult result;
1304 /** If associated with observe, this will represent the sequence of notifications from server.*/
1305 uint32_t sequenceNumber;
1308 const char * resourceUri;
1310 /** the payload for the response PDU.*/
1313 /** Number of the received vendor specific header options.*/
1314 uint8_t numRcvdVendorSpecificHeaderOptions;
1316 /** An array of the received vendor specific header options.*/
1317 OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1321 * Request handle is passed to server via the entity handler for each incoming request.
1322 * Stack assigns when request is received, server sets to indicate what request response is for.
1326 /** Request handle.*/
1327 OCRequestHandle requestHandle;
1329 /** Resource handle.*/
1330 OCResourceHandle resourceHandle;
1332 /** Allow the entity handler to pass a result with the response.*/
1333 OCEntityHandlerResult ehResult;
1335 /** This is the pointer to server payload data to be transferred.*/
1338 /** number of the vendor specific header options .*/
1339 uint8_t numSendVendorSpecificHeaderOptions;
1341 /** An array of the vendor specific header options the entity handler wishes to use in response.*/
1342 OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1344 /** URI of new resource that entity handler might create.*/
1345 char resourceUri[MAX_URI_LENGTH];
1347 /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
1348 uint8_t persistentBufferFlag;
1349 } OCEntityHandlerResponse;
1356 /** Request state.*/
1357 OC_REQUEST_FLAG = (1 << 1),
1358 /** Observe state.*/
1359 OC_OBSERVE_FLAG = (1 << 2)
1360 } OCEntityHandlerFlag;
1363 * Possible returned values from client application.
1367 OC_STACK_DELETE_TRANSACTION = 0,
1368 OC_STACK_KEEP_TRANSACTION
1369 } OCStackApplicationResult;
1372 //#ifdef DIRECT_PAIRING
1374 * @brief direct pairing Method Type.
1376 * 1: pre-configured pin
1381 DP_NOT_ALLOWED = 0x0,
1382 DP_PRE_CONFIGURED = (0x1 << 0),
1383 DP_RANDOM_PIN = (0x1 << 1),
1387 * Device Information of discoverd direct pairing device(s).
1389 typedef struct OCDPDev
1392 OCConnectivityType connType;
1393 uint16_t securePort;
1397 OCUUIdentity deviceID;
1398 OCUUIdentity rowner;
1399 struct OCDPDev *next;
1401 //#endif // DIRECT_PAIRING
1404 * -------------------------------------------------------------------------------------------
1405 * Callback function definitions
1406 * -------------------------------------------------------------------------------------------
1410 * Client applications implement this callback to consume responses received from Servers.
1412 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
1413 OCClientResponse * clientResponse);
1416 * Client applications using a context pointer implement this callback to delete the
1417 * context upon removal of the callback/context pointer from the internal callback-list.
1419 typedef void (* OCClientContextDeleter)(void *context);
1422 * This info is passed from application to OC Stack when initiating a request to Server.
1424 typedef struct OCCallbackData
1426 /** Pointer to the context.*/
1429 /** The pointer to a function the stack will call to handle the requests.*/
1430 OCClientResponseHandler cb;
1432 /** A pointer to a function to delete the context when this callback is removed.*/
1433 OCClientContextDeleter cd;
1435 #ifdef SUPPORTS_DEFAULT_CTOR
1436 OCCallbackData() = default;
1437 OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
1438 :context(ctx), cb(callback), cd(deleter){}
1443 * Application server implementations must implement this callback to consume requests OTA.
1444 * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
1446 typedef OCEntityHandlerResult (*OCEntityHandler)
1447 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, void* callbackParam);
1450 * Device Entity handler need to use this call back instead of OCEntityHandler.
1452 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
1453 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri, void* callbackParam);
1455 //#ifdef DIRECT_PAIRING
1457 * Callback function definition of direct-pairing
1459 * @param[OUT] peer - pairing device info.
1460 * @param[OUT} result - It's returned with 'OC_STACK_XXX'. It will return 'OC_STACK_OK'
1461 * if D2D pairing is success without error
1463 typedef void (*OCDirectPairingCB)(OCDPDev_t *peer, OCStackResult result);
1464 //#endif // DIRECT_PAIRING
1468 #endif // __cplusplus
1470 #endif /* OCTYPES_H_ */