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"
74 #define OC_RSRVD_WELL_KNOWN_MQ_URI "/.well-known/ocf/ps"
79 /** Presence URI through which the OIC devices advertise their presence.*/
80 #define OC_RSRVD_PRESENCE_URI "/oic/ad"
83 /** Presence URI through which the OCF devices advertise their device presence.*/
84 #define OCF_RSRVD_DEVICE_PRESENCE_URI "/.well-known/ocf/prs"
87 /** Sets the default time to live (TTL) for presence.*/
88 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
90 /** For multicast Discovery mechanism.*/
91 #define OC_MULTICAST_DISCOVERY_URI "/oic/res"
93 /** Separator for multiple query string.*/
94 #define OC_QUERY_SEPARATOR "&;"
97 * OC_DEFAULT_PRESENCE_TTL_SECONDS sets the default time to live (TTL) for presence.
99 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
102 * OC_MAX_PRESENCE_TTL_SECONDS sets the maximum time to live (TTL) for presence.
103 * NOTE: Changing the setting to a longer duration may lead to unsupported and untested
105 * 60 sec/min * 60 min/hr * 24 hr/day
107 #define OC_MAX_PRESENCE_TTL_SECONDS (60 * 60 * 24)
111 * Presence "Announcement Triggers".
115 #define OC_RSRVD_TRIGGER_CREATE "create"
118 #define OC_RSRVD_TRIGGER_CHANGE "change"
121 #define OC_RSRVD_TRIGGER_DELETE "delete"
124 * Attributes used to form a proper OIC conforming JSON message.
127 #define OC_RSRVD_OC "oic"
131 #define OC_RSRVD_PAYLOAD "payload"
133 /** To represent href */
134 #define OC_RSRVD_HREF "href"
136 /** To represent property*/
137 #define OC_RSRVD_PROPERTY "prop"
139 /** For representation.*/
140 #define OC_RSRVD_REPRESENTATION "rep"
142 /** To represent content type.*/
143 #define OC_RSRVD_CONTENT_TYPE "ct"
145 /** To represent resource type.*/
146 #define OC_RSRVD_RESOURCE_TYPE "rt"
148 /** To represent resource type with presence.*/
149 #define OC_RSRVD_RESOURCE_TYPE_PRESENCE "oic.wk.ad"
151 /** To represent resource type with device.*/
152 #define OC_RSRVD_RESOURCE_TYPE_DEVICE "oic.wk.d"
154 /** To represent resource type with platform.*/
155 #define OC_RSRVD_RESOURCE_TYPE_PLATFORM "oic.wk.p"
157 /** To represent resource type with RES.*/
158 #define OC_RSRVD_RESOURCE_TYPE_RES "oic.wk.res"
161 /** To represent content type with MQ Broker.*/
162 #define OC_RSRVD_RESOURCE_TYPE_MQ_BROKER "ocf.wk.ps"
164 /** To represent content type with MQ Topic.*/
165 #define OC_RSRVD_RESOURCE_TYPE_MQ_TOPIC "ocf.wk.ps.topic"
168 /** To represent interface.*/
169 #define OC_RSRVD_INTERFACE "if"
171 /** To indicate how long RD should publish this item.*/
172 #define OC_RSRVD_DEVICE_TTL "lt"
174 /** To represent time to live.*/
175 #define OC_RSRVD_TTL "ttl"
177 /** To represent non*/
178 #define OC_RSRVD_NONCE "non"
180 /** To represent trigger type.*/
181 #define OC_RSRVD_TRIGGER "trg"
183 /** To represent links.*/
184 #define OC_RSRVD_LINKS "links"
186 /** To represent default interface.*/
187 #define OC_RSRVD_INTERFACE_DEFAULT "oic.if.baseline"
189 /** To represent read-only interface.*/
190 #define OC_RSRVD_INTERFACE_READ "oic.if.r"
192 /** To represent ll interface.*/
193 #define OC_RSRVD_INTERFACE_LL "oic.if.ll"
195 /** To represent batch interface.*/
196 #define OC_RSRVD_INTERFACE_BATCH "oic.if.b"
198 /** To represent interface group.*/
199 #define OC_RSRVD_INTERFACE_GROUP "oic.mi.grp"
201 /** To represent MFG date.*/
202 #define OC_RSRVD_MFG_DATE "mndt"
204 /** To represent FW version.*/
205 #define OC_RSRVD_FW_VERSION "mnfv"
207 /** To represent host name.*/
208 #define OC_RSRVD_HOST_NAME "hn"
210 /** To represent policy.*/
211 #define OC_RSRVD_POLICY "p"
213 /** To represent bitmap.*/
214 #define OC_RSRVD_BITMAP "bm"
217 #define OC_RSRVD_SECURE "sec"
220 #define OC_RSRVD_HOSTING_PORT "port"
223 #define OC_RSRVD_TCP_PORT "x.org.iotivity.tcp"
225 /** For Server instance ID.*/
226 #define OC_RSRVD_SERVER_INSTANCE_ID "sid"
233 #define OC_RSRVD_PLATFORM_ID "pi"
235 /** Platform MFG NAME. */
236 #define OC_RSRVD_MFG_NAME "mnmn"
239 #define OC_RSRVD_MFG_URL "mnml"
242 #define OC_RSRVD_MODEL_NUM "mnmo"
244 /** Platform MFG Date.*/
245 #define OC_RSRVD_MFG_DATE "mndt"
247 /** Platform versio.n */
248 #define OC_RSRVD_PLATFORM_VERSION "mnpv"
250 /** Platform Operating system version. */
251 #define OC_RSRVD_OS_VERSION "mnos"
253 /** Platform Hardware version. */
254 #define OC_RSRVD_HARDWARE_VERSION "mnhw"
256 /**Platform Firmware version. */
257 #define OC_RSRVD_FIRMWARE_VERSION "mnfv"
259 /** Support URL for the platform. */
260 #define OC_RSRVD_SUPPORT_URL "mnsl"
262 /** System time for the platform. */
263 #define OC_RSRVD_SYSTEM_TIME "st"
270 #define OC_RSRVD_DEVICE_ID "di"
273 #define OC_RSRVD_DEVICE_NAME "n"
275 /** Device specification version.*/
276 #define OC_RSRVD_SPEC_VERSION "icv"
278 /** Device data model.*/
279 #define OC_RSRVD_DATA_MODEL_VERSION "dmv"
281 /** Device specification version.*/
282 #define OC_SPEC_VERSION "core.1.0.0"
284 /** Device Data Model version.*/
285 #define OC_DATA_MODEL_VERSION "res.1.0.0"
288 * These provide backward compatibility - their use is deprecated.
292 /** Multicast Prefix.*/
293 #define OC_MULTICAST_PREFIX "224.0.1.187:5683"
295 /** Multicast IP address.*/
296 #define OC_MULTICAST_IP "224.0.1.187"
298 /** Multicast Port.*/
299 #define OC_MULTICAST_PORT 5683
302 /** Max Device address size. */
304 #define MAX_ADDR_STR_SIZE (256)
306 /** Max Address could be
307 * "coaps+tcp://[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:yyy.yyy.yyy.yyy]:xxxxx"
308 * +1 for null terminator.
310 #define MAX_ADDR_STR_SIZE (66)
313 /** Length of MAC address */
314 #define MAC_ADDR_STR_SIZE (17)
316 /** Blocks of MAC address */
317 #define MAC_ADDR_BLOCKS (6)
319 /** Max identity size. */
320 #define MAX_IDENTITY_SIZE (37)
322 /** Universal unique identity size. */
323 #define UUID_IDENTITY_SIZE (128/8)
325 /** Resource Directory */
327 /** Resource Directory URI used to Discover RD and Publish resources.*/
328 #define OC_RSRVD_RD_URI "/oic/rd"
330 /** To represent resource type with rd.*/
331 #define OC_RSRVD_RESOURCE_TYPE_RD "oic.wk.rd"
333 /** RD Discovery bias factor type. */
334 #define OC_RSRVD_RD_DISCOVERY_SEL "sel"
337 #define OC_RSRVD_BASE_URI "baseURI"
339 /** Unique value per collection/link. */
340 #define OC_RSRVD_INS "ins"
342 /** Allowable resource types in the links. */
343 #define OC_RSRVD_RTS "rts"
345 /** Default relationship. */
346 #define OC_RSRVD_DREL "drel"
348 /** Defines relationship between links. */
349 #define OC_RSRVD_REL "rel"
351 /** Defines title. */
352 #define OC_RSRVD_TITLE "title"
355 #define OC_RSRVD_URI "anchor"
357 /** Defines media type. */
358 #define OC_RSRVD_MEDIA_TYPE "type"
360 /** To represent resource type with Publish RD.*/
361 #define OC_RSRVD_RESOURCE_TYPE_RDPUBLISH "oic.wk.rdpub"
366 #define OC_RSRVD_ACCOUNT_URI "/.well-known/ocf/account"
368 /** Account session URI.*/
369 #define OC_RSRVD_ACCOUNT_SESSION_URI "/.well-known/ocf/account/session"
371 /** Account token refresh URI.*/
372 #define OC_RSRVD_ACCOUNT_TOKEN_REFRESH_URI "/.well-known/ocf/account/tokenrefresh"
374 /** Defines auth provider. */
375 #define OC_RSRVD_AUTHPROVIDER "authprovider"
377 /** Defines auth code. */
378 #define OC_RSRVD_AUTHCODE "authcode"
380 /** Defines access token. */
381 #define OC_RSRVD_ACCESS_TOKEN "accesstoken"
383 /** Defines login. */
384 #define OC_RSRVD_LOGIN "login"
386 /** Defines search. */
387 #define OC_RSRVD_SEARCH "search"
389 /** Defines grant type. */
390 #define OC_RSRVD_GRANT_TYPE "granttype"
392 /** Defines refresh token. */
393 #define OC_RSRVD_REFRESH_TOKEN "refreshtoken"
395 /** Defines user UUID. */
396 #define OC_RSRVD_USER_UUID "uid"
398 /** Defines options. */
399 #define OC_RSRVD_OPTIONS "options"
401 /** To represent grant type with refresh token. */
402 #define OC_RSRVD_GRANT_TYPE_REFRESH_TOKEN "refresh_token"
405 * Mark a parameter as unused. Used to prevent unused variable compiler warnings.
406 * Used in three cases:
407 * 1. in callbacks when one of the parameters are unused
408 * 2. when due to code changes a functions parameter is no longer
409 * used but must be left in place for backward compatibility
411 * 3. a variable is only used in the debug build variant and would
412 * give a build warning in release mode.
414 #define OC_UNUSED(x) (void)(x)
417 * These enums (OCTransportAdapter and OCTransportFlags) must
418 * be kept synchronized with OCConnectivityType (below) as well as
419 * CATransportAdapter and CATransportFlags (in CACommon.h).
423 /** value zero indicates discovery.*/
424 OC_DEFAULT_ADAPTER = 0,
426 /** IPv4 and IPv6, including 6LoWPAN.*/
427 OC_ADAPTER_IP = (1 << 0),
429 /** GATT over Bluetooth LE.*/
430 OC_ADAPTER_GATT_BTLE = (1 << 1),
432 /** RFCOMM over Bluetooth EDR.*/
433 OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
435 /**Remote Access over XMPP.*/
436 OC_ADAPTER_REMOTE_ACCESS = (1 << 3),
439 OC_ADAPTER_TCP = (1 << 4),
441 /** NFC Transport for Messaging.*/
442 OC_ADAPTER_NFC = (1 << 5)
443 } OCTransportAdapter;
446 * Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
450 /** default flag is 0*/
451 OC_DEFAULT_FLAGS = 0,
453 /** Insecure transport is the default (subject to change).*/
454 /** secure the transport path*/
455 OC_FLAG_SECURE = (1 << 4),
457 /** IPv4 & IPv6 auto-selection is the default.*/
458 /** IP & TCP adapter only.*/
459 OC_IP_USE_V6 = (1 << 5),
461 /** IP & TCP adapter only.*/
462 OC_IP_USE_V4 = (1 << 6),
464 /** Multicast only.*/
465 OC_MULTICAST = (1 << 7),
467 /** Link-Local multicast is the default multicast scope for IPv6.
468 * These are placed here to correspond to the IPv6 multicast address bits.*/
470 /** IPv6 Interface-Local scope (loopback).*/
471 OC_SCOPE_INTERFACE = 0x1,
473 /** IPv6 Link-Local scope (default).*/
476 /** IPv6 Realm-Local scope. */
477 OC_SCOPE_REALM = 0x3,
479 /** IPv6 Admin-Local scope. */
480 OC_SCOPE_ADMIN = 0x4,
482 /** IPv6 Site-Local scope. */
485 /** IPv6 Organization-Local scope. */
488 /**IPv6 Global scope. */
489 OC_SCOPE_GLOBAL = 0xE,
493 /** Bit mask for scope.*/
494 #define OC_MASK_SCOPE (0x000F)
496 /** Bit mask for Mods.*/
497 #define OC_MASK_MODS (0x0FF0)
498 #define OC_MASK_FAMS (OC_IP_USE_V6|OC_IP_USE_V4)
500 typedef struct OCStringLL
502 struct OCStringLL *next;
507 * End point identity.
511 /** Identity Length */
514 /** Array of end point identity.*/
515 unsigned char id[MAX_IDENTITY_SIZE];
519 * Universally unique identifier.
523 /** identitifier string.*/
524 unsigned char id[UUID_IDENTITY_SIZE];
528 * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
529 * OCDevAddr must be the same as CAEndpoint (in CACommon.h).
534 OCTransportAdapter adapter;
536 /** transport modifiers.*/
537 OCTransportFlags flags;
542 /** address for all adapters.*/
543 char addr[MAX_ADDR_STR_SIZE];
545 /** usually zero for default interface.*/
547 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
548 char routeData[MAX_ADDR_STR_SIZE]; //destination GatewayID:ClientId
553 * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
554 * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
555 * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
558 * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
562 /** use when defaults are ok. */
565 /** IPv4 and IPv6, including 6LoWPAN.*/
566 CT_ADAPTER_IP = (1 << 16),
568 /** GATT over Bluetooth LE.*/
569 CT_ADAPTER_GATT_BTLE = (1 << 17),
571 /** RFCOMM over Bluetooth EDR.*/
572 CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
575 /** Remote Access over XMPP.*/
576 CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
579 CT_ADAPTER_TCP = (1 << 20),
582 CT_ADAPTER_NFC = (1 << 21),
584 /** Insecure transport is the default (subject to change).*/
586 /** secure the transport path.*/
587 CT_FLAG_SECURE = (1 << 4),
589 /** IPv4 & IPv6 autoselection is the default.*/
591 /** IP adapter only.*/
592 CT_IP_USE_V6 = (1 << 5),
594 /** IP adapter only.*/
595 CT_IP_USE_V4 = (1 << 6),
597 /** Link-Local multicast is the default multicast scope for IPv6.
598 * These are placed here to correspond to the IPv6 address bits.*/
600 /** IPv6 Interface-Local scope(loopback).*/
601 CT_SCOPE_INTERFACE = 0x1,
603 /** IPv6 Link-Local scope (default).*/
606 /** IPv6 Realm-Local scope.*/
607 CT_SCOPE_REALM = 0x3,
609 /** IPv6 Admin-Local scope.*/
610 CT_SCOPE_ADMIN = 0x4,
612 /** IPv6 Site-Local scope.*/
615 /** IPv6 Organization-Local scope.*/
618 /** IPv6 Global scope.*/
619 CT_SCOPE_GLOBAL = 0xE,
620 } OCConnectivityType;
622 /** bit shift required for connectivity adapter.*/
623 #define CT_ADAPTER_SHIFT 16
626 #define CT_MASK_FLAGS 0xFFFF
629 #define CT_MASK_ADAPTER 0xFFFF0000
632 * OCDoResource methods to dispatch the request
636 OC_REST_NOMETHOD = 0,
639 OC_REST_GET = (1 << 0),
642 OC_REST_PUT = (1 << 1),
645 OC_REST_POST = (1 << 2),
648 OC_REST_DELETE = (1 << 3),
650 /** Register observe request for most up date notifications ONLY.*/
651 OC_REST_OBSERVE = (1 << 4),
653 /** Register observe request for all notifications, including stale notifications.*/
654 OC_REST_OBSERVE_ALL = (1 << 5),
656 /** De-register observation, intended for internal use.*/
657 OC_REST_CANCEL_OBSERVE = (1 << 6),
660 /** Subscribe for all presence notifications of a particular resource.*/
661 OC_REST_PRESENCE = (1 << 7),
664 /** Allows OCDoResource caller to do discovery.*/
665 OC_REST_DISCOVER = (1 << 8)
669 * Formats for payload encoding.
675 OC_FORMAT_UNSUPPORTED,
679 * Host Mode of Operation.
686 OC_GATEWAY /**< Client server mode along with routing capabilities.*/
690 * Quality of Service attempts to abstract the guarantees provided by the underlying transport
691 * protocol. The precise definitions of each quality of service level depend on the
692 * implementation. In descriptions below are for the current implementation and may changed
697 /** Packet delivery is best effort.*/
700 /** Packet delivery is best effort.*/
703 /** Acknowledgments are used to confirm delivery.*/
706 /** No Quality is defined, let the stack decide.*/
708 } OCQualityOfService;
711 * Resource Properties.
712 * The value of a policy property is defined as bitmap.
713 * The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
714 * Not including the policy property is equivalent to zero.
719 /** When none of the bits are set, the resource is non-discoverable &
720 * non-observable by the client.*/
721 OC_RES_PROP_NONE = (0),
723 /** When this bit is set, the resource is allowed to be discovered by clients.*/
724 OC_DISCOVERABLE = (1 << 0),
726 /** When this bit is set, the resource is allowed to be observed by clients.*/
727 OC_OBSERVABLE = (1 << 1),
729 /** When this bit is set, the resource is initialized, otherwise the resource
730 * is 'inactive'. 'inactive' signifies that the resource has been marked for
731 * deletion or is already deleted.*/
732 OC_ACTIVE = (1 << 2),
734 /** When this bit is set, the resource has been marked as 'slow'.
735 * 'slow' signifies that responses from this resource can expect delays in
736 * processing its requests from clients.*/
740 /** When this bit is set, the resource is a secure resource.*/
741 OC_SECURE = (1 << 4),
746 /** When this bit is set, the resource is allowed to be discovered only
747 * if discovery request contains an explicit querystring.
748 * Ex: GET /oic/res?rt=oic.sec.acl */
749 OC_EXPLICIT_DISCOVERABLE = (1 << 5)
752 /** When this bit is set, the resource is allowed to be published */
753 ,OC_MQ_PUBLISHER = (1 << 6)
757 /** When this bit is set, the resource is allowed to be notified as MQ broker.*/
758 ,OC_MQ_BROKER = (1 << 7)
760 } OCResourceProperty;
763 * Transport Protocol IDs.
767 /** For invalid ID.*/
768 OC_INVALID_ID = (1 << 0),
771 OC_COAP_ID = (1 << 1)
772 } OCTransportProtocolID;
775 * Declares Stack Results & Errors.
779 /** Success status code - START HERE.*/
781 OC_STACK_RESOURCE_CREATED,
782 OC_STACK_RESOURCE_DELETED,
784 OC_STACK_RESOURCE_CHANGED,
785 /** Success status code - END HERE.*/
787 /** Error status code - START HERE.*/
788 OC_STACK_INVALID_URI = 20,
789 OC_STACK_INVALID_QUERY,
791 OC_STACK_INVALID_PORT,
792 OC_STACK_INVALID_CALLBACK,
793 OC_STACK_INVALID_METHOD,
795 /** Invalid parameter.*/
796 OC_STACK_INVALID_PARAM,
797 OC_STACK_INVALID_OBSERVE_PARAM,
801 OC_STACK_ADAPTER_NOT_ENABLED,
804 /** Resource not found.*/
805 OC_STACK_NO_RESOURCE,
807 /** e.g: not supported method or interface.*/
808 OC_STACK_RESOURCE_ERROR,
809 OC_STACK_SLOW_RESOURCE,
810 OC_STACK_DUPLICATE_REQUEST,
812 /** Resource has no registered observers.*/
813 OC_STACK_NO_OBSERVERS,
814 OC_STACK_OBSERVER_NOT_FOUND,
815 OC_STACK_VIRTUAL_DO_NOT_HANDLE,
816 OC_STACK_INVALID_OPTION,
818 /** The remote reply contained malformed data.*/
819 OC_STACK_MALFORMED_RESPONSE,
820 OC_STACK_PERSISTENT_BUFFER_REQUIRED,
821 OC_STACK_INVALID_REQUEST_HANDLE,
822 OC_STACK_INVALID_DEVICE_INFO,
823 OC_STACK_INVALID_JSON,
825 /** Request is not authorized by Resource Server. */
826 OC_STACK_UNAUTHORIZED_REQ,
827 OC_STACK_TOO_LARGE_REQ,
829 /** Error code from PDM */
830 OC_STACK_PDM_IS_NOT_INITIALIZED,
831 OC_STACK_DUPLICATE_UUID,
832 OC_STACK_INCONSISTENT_DB,
835 * Error code from OTM
836 * This error is pushed from DTLS interface when handshake failure happens
838 OC_STACK_AUTHENTICATION_FAILURE,
840 /** Insert all new error codes here!.*/
842 OC_STACK_PRESENCE_STOPPED = 128,
843 OC_STACK_PRESENCE_TIMEOUT,
844 OC_STACK_PRESENCE_DO_NOT_HANDLE,
846 /** ERROR in stack.*/
848 /** Error status code - END HERE.*/
852 * Handle to an OCDoResource invocation.
854 typedef void * OCDoHandle;
857 * Handle to an OCResource object owned by the OCStack.
859 typedef void * OCResourceHandle;
862 * Handle to an OCRequest object owned by the OCStack.
864 typedef void * OCRequestHandle;
867 * Unique identifier for each observation request. Used when observations are
868 * registered or de-registered. Used by entity handler to signal specific
869 * observers to be notified of resource changes.
870 * There can be maximum of 256 observations per server.
872 typedef uint8_t OCObservationId;
875 * Action associated with observation.
880 OC_OBSERVE_REGISTER = 0,
882 /** To Deregister. */
883 OC_OBSERVE_DEREGISTER = 1,
886 OC_OBSERVE_NO_OPTION = 2,
889 OC_MQ_SUBSCRIBER = 3,
891 OC_MQ_UNSUBSCRIBER = 4,
898 * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
899 * when it calls OCRegisterPersistentStorageHandler.
900 * Persistent storage open handler points to default file path.
901 * It should check file path and whether the file is symbolic link or no.
902 * Application can point to appropriate SVR database path for it's IoTivity Server.
905 /** Persistent storage file path.*/
906 FILE* (* open)(const char *path, const char *mode);
908 /** Persistent storage read handler.*/
909 size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
911 /** Persistent storage write handler.*/
912 size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
914 /** Persistent storage close handler.*/
915 int (* close)(FILE *fp);
917 /** Persistent storage unlink handler.*/
918 int (* unlink)(const char *path);
919 } OCPersistentStorage;
922 * Possible returned values from entity handler.
926 /** Action associated with observation request.*/
927 OCObserveAction action;
929 /** Identifier for observation being registered/deregistered.*/
930 OCObservationId obsId;
934 * Possible returned values from entity handler.
940 OC_EH_RESOURCE_CREATED, // 2.01
941 OC_EH_RESOURCE_DELETED, // 2.02
943 OC_EH_FORBIDDEN, // 4.03
944 OC_EH_RESOURCE_NOT_FOUND, // 4.04
946 OC_EH_CHANGED, // 2.04
947 OC_EH_CONTENT, // 2.05
948 OC_EH_BAD_REQ, // 4.00
949 OC_EH_UNAUTHORIZED_REQ, // 4.01
950 OC_EH_BAD_OPT, // 4.02
951 OC_EH_METHOD_NOT_ALLOWED, // 4.05
952 OC_EH_NOT_ACCEPTABLE, // 4.06
953 OC_EH_INTERNAL_SERVER_ERROR, // 5.00
954 OC_EH_RETRANSMIT_TIMEOUT // 5.04
955 } OCEntityHandlerResult;
958 * This structure will be used to define the vendor specific header options to be included
959 * in communication packets.
961 typedef struct OCHeaderOption
963 /** The protocol ID this option applies to.*/
964 OCTransportProtocolID protocolID;
966 /** The header option ID which will be added to communication packets.*/
969 /** its length 191.*/
970 uint16_t optionLength;
972 /** pointer to its data.*/
973 uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
975 #ifdef SUPPORTS_DEFAULT_CTOR
976 OCHeaderOption() = default;
977 OCHeaderOption(OCTransportProtocolID pid,
980 const uint8_t* optData)
986 // parameter includes the null terminator.
987 optionLength = optionLength < MAX_HEADER_OPTION_DATA_LENGTH ?
988 optionLength : MAX_HEADER_OPTION_DATA_LENGTH;
989 memcpy(optionData, optData, optionLength);
990 optionData[optionLength - 1] = '\0';
997 * This structure describes the platform properties. All non-Null properties will be
998 * included in a platform discovery request.
1005 /** Manufacturer name.*/
1006 char *manufacturerName;
1008 /** Manufacturer URL for platform property.*/
1009 char *manufacturerUrl;
1014 /** Manufacturer date.*/
1015 char *dateOfManufacture;
1017 /** Platform version.*/
1018 char *platformVersion;
1020 /** Operating system version.*/
1021 char *operatingSystemVersion;
1024 char *hardwareVersion;
1027 char *firmwareVersion;
1029 /** Platform support URL.*/
1038 * This structure is expected as input for device properties.
1039 * device name is mandatory and expected from the application.
1040 * device id of type UUID will be generated by the stack.
1044 /** Pointer to the device name.*/
1046 /** Pointer to the types.*/
1048 /** Pointer to the device specification version.*/
1050 /** Pointer to the device data model versions (in CSV format).*/
1051 OCStringLL *dataModelVersions;
1056 * callback for bound JID
1058 typedef void (*jid_bound_cb)(char *jid);
1061 * CA Remote Access information for XMPP Client
1066 char *hostname; /**< XMPP server hostname */
1067 uint16_t port; /**< XMPP server serivce port */
1068 char *xmpp_domain; /**< XMPP login domain */
1069 char *username; /**< login username */
1070 char *password; /**< login password */
1071 char *resource; /**< specific resource for login */
1072 char *user_jid; /**< specific JID for login */
1073 jid_bound_cb jidbound; /**< callback when JID bound */
1075 #endif /* RA_ADAPTER */
1078 /** Enum to describe the type of object held by the OCPayload object.*/
1081 /** Contents of the payload are invalid */
1082 PAYLOAD_TYPE_INVALID,
1083 /** The payload is an OCDiscoveryPayload */
1084 PAYLOAD_TYPE_DISCOVERY,
1085 /** The payload is an OCDevicePayload */
1086 PAYLOAD_TYPE_DEVICE,
1087 /** The payload is an OCPlatformPayload */
1088 PAYLOAD_TYPE_PLATFORM,
1089 /** The payload is an OCRepPayload */
1090 PAYLOAD_TYPE_REPRESENTATION,
1091 /** The payload is an OCSecurityPayload */
1092 PAYLOAD_TYPE_SECURITY,
1093 /** The payload is an OCPresencePayload */
1094 PAYLOAD_TYPE_PRESENCE,
1095 /** The payload is an OCRDPayload */
1100 * A generic struct representing a payload returned from a resource operation
1102 * A pointer to OCPayLoad can be cast to a more specific struct to access members
1107 /** The type of message that was received */
1118 OCREP_PROP_BYTE_STRING,
1121 }OCRepPayloadPropType;
1123 /** This structure will be used to represent a binary string for CBOR payloads.*/
1126 /** pointer to data bytes.*/
1129 /** number of data bytes.*/
1133 #define MAX_REP_ARRAY_DEPTH 3
1136 OCRepPayloadPropType type;
1137 size_t dimensions[MAX_REP_ARRAY_DEPTH];
1146 /** pointer to ByteString array.*/
1147 OCByteString* ocByteStrArray;
1149 struct OCRepPayload** objArray;
1151 } OCRepPayloadValueArray;
1153 typedef struct OCRepPayloadValue
1156 OCRepPayloadPropType type;
1164 /** ByteString object.*/
1165 OCByteString ocByteStr;
1167 struct OCRepPayload* obj;
1168 OCRepPayloadValueArray arr;
1170 struct OCRepPayloadValue* next;
1172 } OCRepPayloadValue;
1174 // used for get/set/put/observe/etc representations
1175 typedef struct OCRepPayload
1180 OCStringLL* interfaces;
1181 OCRepPayloadValue* values;
1182 struct OCRepPayload* next;
1185 // used inside a discovery payload
1186 typedef struct OCResourcePayload
1190 OCStringLL* interfaces;
1197 struct OCResourcePayload* next;
1198 } OCResourcePayload;
1201 * Structure holding Links Payload. It is a sub-structure used in
1202 * OCResourceCollectionPayload.
1204 typedef struct OCLinksPayload
1206 /** This is the target relative URI. */
1208 /** The relation of the target URI referenced by the link to the context URI;
1209 * The default value is null. */
1211 /** Resource Type - A standard OIC specified or vendor defined resource
1212 * type of the resource referenced by the target URI. */
1214 /** Interface - The interfaces supported by the resource referenced by the target URI. */
1216 /** Bitmap - The bitmap holds observable, discoverable, secure option flag. */
1218 /** A title for the link relation. Can be used by the UI to provide a context. */
1220 /** This is used to override the context URI e.g. override the URI of the containing collection. */
1222 /** The instance identifier for this web link in an array of web links - used in links. */
1225 /** An ordinal number that is not repeated - must be unique in the collection context. */
1227 /** Any unique string including a URI. */
1229 /** Use UUID for universal uniqueness - used in /oic/res to identify the device. */
1230 OCIdentity uniqueUUID;
1232 /** Time to keep holding resource.*/
1234 /** A hint of the media type of the representation of the resource referenced by the target URI. */
1236 /** Holding address of the next resource. */
1237 struct OCLinksPayload *next;
1240 /** Structure holding tags value of the links payload. */
1243 /** Name of tags. */
1245 /** Device identifier. */
1247 /** Time to keep holding resource.*/
1251 /** Resource collection payload. */
1252 typedef struct OCResourceCollectionPayload
1254 /** Collection tags payload.*/
1255 OCTagsPayload *tags;
1256 /** Array of links payload. */
1257 OCLinksPayload *setLinks;
1258 } OCResourceCollectionPayload;
1260 typedef struct OCDiscoveryPayload
1267 /** A special case for handling RD address. */
1276 /** Resource Type */
1282 /** This structure holds the old /oic/res response. */
1283 OCResourcePayload *resources;
1285 /** Holding address of the next DiscoveryPayload. */
1286 struct OCDiscoveryPayload *next;
1288 } OCDiscoveryPayload;
1291 * Structure holding discovery payload.
1297 /** Device Identity. */
1299 /** Value holding the bias factor of the RD. */
1301 } OCRDDiscoveryPayload;
1304 * RD Payload that will be transmitted over the wire.
1309 /** Pointer to the discovery response payload.*/
1310 OCRDDiscoveryPayload *rdDiscovery;
1311 /** Pointer to the publish payload.*/
1312 OCResourceCollectionPayload *rdPublish;
1321 OCStringLL *dataModelVersions;
1322 OCStringLL *interfaces;
1330 OCPlatformInfo info;
1332 OCStringLL* interfaces;
1333 } OCPlatformPayload;
1338 uint8_t* securityData;
1340 } OCSecurityPayload;
1342 #ifdef WITH_PRESENCE
1346 uint32_t sequenceNumber;
1348 OCPresenceTrigger trigger;
1350 } OCPresencePayload;
1354 * Incoming requests handled by the server. Requests are passed in as a parameter to the
1355 * OCEntityHandler callback API.
1356 * The OCEntityHandler callback API must be implemented in the application in order
1357 * to receive these requests.
1361 /** Associated resource.*/
1362 OCResourceHandle resource;
1364 /** Associated request handle.*/
1365 OCRequestHandle requestHandle;
1367 /** the REST method retrieved from received request PDU.*/
1370 /** description of endpoint that sent the request.*/
1373 /** resource query send by client.*/
1376 /** Information associated with observation - valid only when OCEntityHandler flag includes
1377 * ::OC_OBSERVE_FLAG.*/
1378 OCObservationInfo obsInfo;
1380 /** Number of the received vendor specific header options.*/
1381 uint8_t numRcvdVendorSpecificHeaderOptions;
1383 /** Pointer to the array of the received vendor specific header options.*/
1384 OCHeaderOption * rcvdVendorSpecificHeaderOptions;
1389 /** the payload from the request PDU.*/
1392 } OCEntityHandlerRequest;
1396 * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
1400 /** Address of remote server.*/
1403 /** backward compatibility (points to devAddr).*/
1406 /** backward compatibility.*/
1407 OCConnectivityType connType;
1409 /** the security identity of the remote server.*/
1410 OCIdentity identity;
1412 /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
1413 OCStackResult result;
1415 /** If associated with observe, this will represent the sequence of notifications from server.*/
1416 uint32_t sequenceNumber;
1419 const char * resourceUri;
1421 /** the payload for the response PDU.*/
1424 /** Number of the received vendor specific header options.*/
1425 uint8_t numRcvdVendorSpecificHeaderOptions;
1427 /** An array of the received vendor specific header options.*/
1428 OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1432 * Request handle is passed to server via the entity handler for each incoming request.
1433 * Stack assigns when request is received, server sets to indicate what request response is for.
1437 /** Request handle.*/
1438 OCRequestHandle requestHandle;
1440 /** Resource handle.*/
1441 OCResourceHandle resourceHandle;
1443 /** Allow the entity handler to pass a result with the response.*/
1444 OCEntityHandlerResult ehResult;
1446 /** This is the pointer to server payload data to be transferred.*/
1449 /** number of the vendor specific header options .*/
1450 uint8_t numSendVendorSpecificHeaderOptions;
1452 /** An array of the vendor specific header options the entity handler wishes to use in response.*/
1453 OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1455 /** URI of new resource that entity handler might create.*/
1456 char resourceUri[MAX_URI_LENGTH];
1458 /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
1459 uint8_t persistentBufferFlag;
1460 } OCEntityHandlerResponse;
1467 /** Request state.*/
1468 OC_REQUEST_FLAG = (1 << 1),
1469 /** Observe state.*/
1470 OC_OBSERVE_FLAG = (1 << 2)
1471 } OCEntityHandlerFlag;
1474 * Possible return values from client application callback
1476 * A client application callback returns an OCStackApplicationResult to indicate whether
1477 * the stack should continue to keep the callback registered.
1481 /** Make no more calls to the callback and call the OCClientContextDeleter for this callback */
1482 OC_STACK_DELETE_TRANSACTION = 0,
1483 /** Keep this callback registered and call it if an apropriate event occurs */
1484 OC_STACK_KEEP_TRANSACTION
1485 } OCStackApplicationResult;
1488 //#ifdef DIRECT_PAIRING
1490 * @brief direct pairing Method Type.
1492 * 1: pre-configured pin
1497 DP_NOT_ALLOWED = 0x0,
1498 DP_PRE_CONFIGURED = (0x1 << 0),
1499 DP_RANDOM_PIN = (0x1 << 1),
1503 * Device Information of discoverd direct pairing device(s).
1505 typedef struct OCDPDev
1508 OCConnectivityType connType;
1509 uint16_t securePort;
1513 OCUUIdentity deviceID;
1514 OCUUIdentity rowner;
1515 struct OCDPDev *next;
1517 //#endif // DIRECT_PAIRING
1520 * -------------------------------------------------------------------------------------------
1521 * Callback function definitions
1522 * -------------------------------------------------------------------------------------------
1526 * Client applications implement this callback to consume responses received from Servers.
1528 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
1529 OCClientResponse * clientResponse);
1532 * Client applications using a context pointer implement this callback to delete the
1533 * context upon removal of the callback/context pointer from the internal callback-list.
1535 typedef void (* OCClientContextDeleter)(void *context);
1538 * This info is passed from application to OC Stack when initiating a request to Server.
1540 typedef struct OCCallbackData
1542 /** Pointer to the context.*/
1545 /** The pointer to a function the stack will call to handle the requests.*/
1546 OCClientResponseHandler cb;
1548 /** A pointer to a function to delete the context when this callback is removed.*/
1549 OCClientContextDeleter cd;
1551 #ifdef SUPPORTS_DEFAULT_CTOR
1552 OCCallbackData() = default;
1553 OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
1554 :context(ctx), cb(callback), cd(deleter){}
1559 * Application server implementations must implement this callback to consume requests OTA.
1560 * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
1562 typedef OCEntityHandlerResult (*OCEntityHandler)
1563 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, void* callbackParam);
1566 * Device Entity handler need to use this call back instead of OCEntityHandler.
1568 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
1569 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri, void* callbackParam);
1571 //#ifdef DIRECT_PAIRING
1573 * Callback function definition of direct-pairing
1575 * @param[OUT] ctx - user context returned in the callback.
1576 * @param[OUT] peer - pairing device info.
1577 * @param[OUT} result - It's returned with 'OC_STACK_XXX'. It will return 'OC_STACK_OK'
1578 * if D2D pairing is success without error
1580 typedef void (*OCDirectPairingCB)(void *ctx, OCDPDev_t *peer, OCStackResult result);
1581 //#endif // DIRECT_PAIRING
1585 #endif // __cplusplus
1587 #endif /* OCTYPES_H_ */