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 represent time to live.*/
172 #define OC_RSRVD_TTL "ttl"
174 /** To represent non*/
175 #define OC_RSRVD_NONCE "non"
177 /** To represent trigger type.*/
178 #define OC_RSRVD_TRIGGER "trg"
180 /** To represent links.*/
181 #define OC_RSRVD_LINKS "links"
183 /** To represent default interface.*/
184 #define OC_RSRVD_INTERFACE_DEFAULT "oic.if.baseline"
186 /** To represent read-only interface.*/
187 #define OC_RSRVD_INTERFACE_READ "oic.if.r"
189 /** To represent ll interface.*/
190 #define OC_RSRVD_INTERFACE_LL "oic.if.ll"
192 /** To represent batch interface.*/
193 #define OC_RSRVD_INTERFACE_BATCH "oic.if.b"
195 /** To represent interface group.*/
196 #define OC_RSRVD_INTERFACE_GROUP "oic.mi.grp"
198 /** To represent MFG date.*/
199 #define OC_RSRVD_MFG_DATE "mndt"
201 /** To represent FW version.*/
202 #define OC_RSRVD_FW_VERSION "mnfv"
204 /** To represent host name.*/
205 #define OC_RSRVD_HOST_NAME "hn"
207 /** To represent policy.*/
208 #define OC_RSRVD_POLICY "p"
210 /** To represent bitmap.*/
211 #define OC_RSRVD_BITMAP "bm"
214 #define OC_RSRVD_SECURE "sec"
217 #define OC_RSRVD_HOSTING_PORT "port"
220 #define OC_RSRVD_TCP_PORT "x.org.iotivity.tcp"
222 /** For Server instance ID.*/
223 #define OC_RSRVD_SERVER_INSTANCE_ID "sid"
230 #define OC_RSRVD_PLATFORM_ID "pi"
232 /** Platform MFG NAME. */
233 #define OC_RSRVD_MFG_NAME "mnmn"
236 #define OC_RSRVD_MFG_URL "mnml"
239 #define OC_RSRVD_MODEL_NUM "mnmo"
241 /** Platform MFG Date.*/
242 #define OC_RSRVD_MFG_DATE "mndt"
244 /** Platform versio.n */
245 #define OC_RSRVD_PLATFORM_VERSION "mnpv"
247 /** Platform Operating system version. */
248 #define OC_RSRVD_OS_VERSION "mnos"
250 /** Platform Hardware version. */
251 #define OC_RSRVD_HARDWARE_VERSION "mnhw"
253 /**Platform Firmware version. */
254 #define OC_RSRVD_FIRMWARE_VERSION "mnfv"
256 /** Support URL for the platform. */
257 #define OC_RSRVD_SUPPORT_URL "mnsl"
259 /** System time for the platform. */
260 #define OC_RSRVD_SYSTEM_TIME "st"
267 #define OC_RSRVD_DEVICE_ID "di"
270 #define OC_RSRVD_DEVICE_NAME "n"
272 /** Device specification version.*/
273 #define OC_RSRVD_SPEC_VERSION "icv"
275 /** Device data model.*/
276 #define OC_RSRVD_DATA_MODEL_VERSION "dmv"
278 /** Device specification version.*/
279 #define OC_SPEC_VERSION "core.1.0.0"
281 /** Device Data Model version.*/
282 #define OC_DATA_MODEL_VERSION "res.1.0.0"
285 * These provide backward compatibility - their use is deprecated.
289 /** Multicast Prefix.*/
290 #define OC_MULTICAST_PREFIX "224.0.1.187:5683"
292 /** Multicast IP address.*/
293 #define OC_MULTICAST_IP "224.0.1.187"
295 /** Multicast Port.*/
296 #define OC_MULTICAST_PORT 5683
299 /** Max Device address size. */
301 #define MAX_ADDR_STR_SIZE (256)
303 /** Max Address could be
304 * "coaps+tcp://[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:yyy.yyy.yyy.yyy]:xxxxx"
305 * +1 for null terminator.
307 #define MAX_ADDR_STR_SIZE (66)
310 /** Length of MAC address */
311 #define MAC_ADDR_STR_SIZE (17)
313 /** Blocks of MAC address */
314 #define MAC_ADDR_BLOCKS (6)
316 /** Max identity size. */
317 #define MAX_IDENTITY_SIZE (32)
319 /** Universal unique identity size. */
320 #define UUID_IDENTITY_SIZE (128/8)
322 /** Resource Directory */
324 /** Resource Directory URI used to Discover RD and Publish resources.*/
325 #define OC_RSRVD_RD_URI "/oic/rd"
327 /** To represent resource type with rd.*/
328 #define OC_RSRVD_RESOURCE_TYPE_RD "oic.wk.rd"
330 /** RD Discovery bias factor type. */
331 #define OC_RSRVD_RD_DISCOVERY_SEL "sel"
334 #define OC_RSRVD_BASE_URI "baseURI"
336 /** Unique value per collection/link. */
337 #define OC_RSRVD_INS "ins"
339 /** Allowable resource types in the links. */
340 #define OC_RSRVD_RTS "rts"
342 /** Default relationship. */
343 #define OC_RSRVD_DREL "drel"
345 /** Defines relationship between links. */
346 #define OC_RSRVD_REL "rel"
348 /** Defines title. */
349 #define OC_RSRVD_TITLE "title"
352 #define OC_RSRVD_URI "uri"
354 /** Defines media type. */
355 #define OC_RSRVD_MEDIA_TYPE "mt"
357 /** To represent resource type with Publish RD.*/
358 #define OC_RSRVD_RESOURCE_TYPE_RDPUBLISH "oic.wk.rdpub"
363 #define OC_RSRVD_ACCOUNT_URI "/.well-known/ocf/account"
365 /** Account session URI.*/
366 #define OC_RSRVD_ACCOUNT_SESSION_URI "/.well-known/ocf/account/session"
368 /** Account token refresh URI.*/
369 #define OC_RSRVD_ACCOUNT_TOKEN_REFRESH_URI "/.well-known/ocf/account/tokenrefresh"
371 /** Defines auth provider. */
372 #define OC_RSRVD_AUTHPROVIDER "authprovider"
374 /** Defines auth code. */
375 #define OC_RSRVD_AUTHCODE "authcode"
377 /** Defines session. */
378 #define OC_RSRVD_ACCESS_TOKEN "accesstoken"
380 /** Defines status. */
381 #define OC_RSRVD_STATUS "status"
383 /** Defines grant type. */
384 #define OC_RSRVD_GRANT_TYPE "granttype"
386 /** Defines refresh token. */
387 #define OC_RSRVD_REFRESH_TOKEN "refreshtoken"
389 /** To represent grant type with refresh token. */
390 #define OC_RSRVD_GRANT_TYPE_REFRESH_TOKEN "refresh_token"
393 * Mark a parameter as unused. Used to prevent unused variable compiler warnings.
394 * Used in three cases:
395 * 1. in callbacks when one of the parameters are unused
396 * 2. when due to code changes a functions parameter is no longer
397 * used but must be left in place for backward compatibility
399 * 3. a variable is only used in the debug build variant and would
400 * give a build warning in release mode.
402 #define OC_UNUSED(x) (void)(x)
405 * These enums (OCTransportAdapter and OCTransportFlags) must
406 * be kept synchronized with OCConnectivityType (below) as well as
407 * CATransportAdapter and CATransportFlags (in CACommon.h).
411 /** value zero indicates discovery.*/
412 OC_DEFAULT_ADAPTER = 0,
414 /** IPv4 and IPv6, including 6LoWPAN.*/
415 OC_ADAPTER_IP = (1 << 0),
417 /** GATT over Bluetooth LE.*/
418 OC_ADAPTER_GATT_BTLE = (1 << 1),
420 /** RFCOMM over Bluetooth EDR.*/
421 OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
423 /**Remote Access over XMPP.*/
424 OC_ADAPTER_REMOTE_ACCESS = (1 << 3),
427 OC_ADAPTER_TCP = (1 << 4),
429 /** NFC Transport for Messaging.*/
430 OC_ADAPTER_NFC = (1 << 5)
431 } OCTransportAdapter;
434 * Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
438 /** default flag is 0*/
439 OC_DEFAULT_FLAGS = 0,
441 /** Insecure transport is the default (subject to change).*/
442 /** secure the transport path*/
443 OC_FLAG_SECURE = (1 << 4),
445 /** IPv4 & IPv6 auto-selection is the default.*/
446 /** IP & TCP adapter only.*/
447 OC_IP_USE_V6 = (1 << 5),
449 /** IP & TCP adapter only.*/
450 OC_IP_USE_V4 = (1 << 6),
452 /** Multicast only.*/
453 OC_MULTICAST = (1 << 7),
455 /** Link-Local multicast is the default multicast scope for IPv6.
456 * These are placed here to correspond to the IPv6 multicast address bits.*/
458 /** IPv6 Interface-Local scope (loopback).*/
459 OC_SCOPE_INTERFACE = 0x1,
461 /** IPv6 Link-Local scope (default).*/
464 /** IPv6 Realm-Local scope. */
465 OC_SCOPE_REALM = 0x3,
467 /** IPv6 Admin-Local scope. */
468 OC_SCOPE_ADMIN = 0x4,
470 /** IPv6 Site-Local scope. */
473 /** IPv6 Organization-Local scope. */
476 /**IPv6 Global scope. */
477 OC_SCOPE_GLOBAL = 0xE,
481 /** Bit mask for scope.*/
482 #define OC_MASK_SCOPE (0x000F)
484 /** Bit mask for Mods.*/
485 #define OC_MASK_MODS (0x0FF0)
486 #define OC_MASK_FAMS (OC_IP_USE_V6|OC_IP_USE_V4)
488 typedef struct OCStringLL
490 struct OCStringLL *next;
495 * End point identity.
499 /** Identity Length */
502 /** Array of end point identity.*/
503 unsigned char id[MAX_IDENTITY_SIZE];
507 * Universally unique identifier.
511 /** identitifier string.*/
512 unsigned char id[UUID_IDENTITY_SIZE];
516 * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
517 * OCDevAddr must be the same as CAEndpoint (in CACommon.h).
522 OCTransportAdapter adapter;
524 /** transport modifiers.*/
525 OCTransportFlags flags;
530 /** address for all adapters.*/
531 char addr[MAX_ADDR_STR_SIZE];
533 /** usually zero for default interface.*/
535 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
536 char routeData[MAX_ADDR_STR_SIZE]; //destination GatewayID:ClientId
541 * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
542 * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
543 * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
546 * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
550 /** use when defaults are ok. */
553 /** IPv4 and IPv6, including 6LoWPAN.*/
554 CT_ADAPTER_IP = (1 << 16),
556 /** GATT over Bluetooth LE.*/
557 CT_ADAPTER_GATT_BTLE = (1 << 17),
559 /** RFCOMM over Bluetooth EDR.*/
560 CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
563 /** Remote Access over XMPP.*/
564 CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
567 CT_ADAPTER_TCP = (1 << 20),
570 CT_ADAPTER_NFC = (1 << 21),
572 /** Insecure transport is the default (subject to change).*/
574 /** secure the transport path.*/
575 CT_FLAG_SECURE = (1 << 4),
577 /** IPv4 & IPv6 autoselection is the default.*/
579 /** IP adapter only.*/
580 CT_IP_USE_V6 = (1 << 5),
582 /** IP adapter only.*/
583 CT_IP_USE_V4 = (1 << 6),
585 /** Link-Local multicast is the default multicast scope for IPv6.
586 * These are placed here to correspond to the IPv6 address bits.*/
588 /** IPv6 Interface-Local scope(loopback).*/
589 CT_SCOPE_INTERFACE = 0x1,
591 /** IPv6 Link-Local scope (default).*/
594 /** IPv6 Realm-Local scope.*/
595 CT_SCOPE_REALM = 0x3,
597 /** IPv6 Admin-Local scope.*/
598 CT_SCOPE_ADMIN = 0x4,
600 /** IPv6 Site-Local scope.*/
603 /** IPv6 Organization-Local scope.*/
606 /** IPv6 Global scope.*/
607 CT_SCOPE_GLOBAL = 0xE,
608 } OCConnectivityType;
610 /** bit shift required for connectivity adapter.*/
611 #define CT_ADAPTER_SHIFT 16
614 #define CT_MASK_FLAGS 0xFFFF
617 #define CT_MASK_ADAPTER 0xFFFF0000
620 * OCDoResource methods to dispatch the request
624 OC_REST_NOMETHOD = 0,
627 OC_REST_GET = (1 << 0),
630 OC_REST_PUT = (1 << 1),
633 OC_REST_POST = (1 << 2),
636 OC_REST_DELETE = (1 << 3),
638 /** Register observe request for most up date notifications ONLY.*/
639 OC_REST_OBSERVE = (1 << 4),
641 /** Register observe request for all notifications, including stale notifications.*/
642 OC_REST_OBSERVE_ALL = (1 << 5),
644 /** De-register observation, intended for internal use.*/
645 OC_REST_CANCEL_OBSERVE = (1 << 6),
648 /** Subscribe for all presence notifications of a particular resource.*/
649 OC_REST_PRESENCE = (1 << 7),
652 /** Allows OCDoResource caller to do discovery.*/
653 OC_REST_DISCOVER = (1 << 8)
657 * Formats for payload encoding.
663 OC_FORMAT_UNSUPPORTED,
667 * Host Mode of Operation.
674 OC_GATEWAY /**< Client server mode along with routing capabilities.*/
678 * Quality of Service attempts to abstract the guarantees provided by the underlying transport
679 * protocol. The precise definitions of each quality of service level depend on the
680 * implementation. In descriptions below are for the current implementation and may changed
685 /** Packet delivery is best effort.*/
688 /** Packet delivery is best effort.*/
691 /** Acknowledgments are used to confirm delivery.*/
694 /** No Quality is defined, let the stack decide.*/
696 } OCQualityOfService;
699 * Resource Properties.
700 * The value of a policy property is defined as bitmap.
701 * The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
702 * Not including the policy property is equivalent to zero.
707 /** When none of the bits are set, the resource is non-discoverable &
708 * non-observable by the client.*/
709 OC_RES_PROP_NONE = (0),
711 /** When this bit is set, the resource is allowed to be discovered by clients.*/
712 OC_DISCOVERABLE = (1 << 0),
714 /** When this bit is set, the resource is allowed to be observed by clients.*/
715 OC_OBSERVABLE = (1 << 1),
717 /** When this bit is set, the resource is initialized, otherwise the resource
718 * is 'inactive'. 'inactive' signifies that the resource has been marked for
719 * deletion or is already deleted.*/
720 OC_ACTIVE = (1 << 2),
722 /** When this bit is set, the resource has been marked as 'slow'.
723 * 'slow' signifies that responses from this resource can expect delays in
724 * processing its requests from clients.*/
728 /** When this bit is set, the resource is a secure resource.*/
729 OC_SECURE = (1 << 4),
734 /** When this bit is set, the resource is allowed to be discovered only
735 * if discovery request contains an explicit querystring.
736 * Ex: GET /oic/res?rt=oic.sec.acl */
737 OC_EXPLICIT_DISCOVERABLE = (1 << 5)
740 /** When this bit is set, the resource is allowed to be published */
741 ,OC_MQ_PUBLISHER = (1 << 6)
745 /** When this bit is set, the resource is allowed to be notified as MQ broker.*/
746 ,OC_MQ_BROKER = (1 << 7)
748 } OCResourceProperty;
751 * Transport Protocol IDs.
755 /** For invalid ID.*/
756 OC_INVALID_ID = (1 << 0),
759 OC_COAP_ID = (1 << 1)
760 } OCTransportProtocolID;
763 * Declares Stack Results & Errors.
767 /** Success status code - START HERE.*/
769 OC_STACK_RESOURCE_CREATED,
770 OC_STACK_RESOURCE_DELETED,
772 OC_STACK_RESOURCE_CHANGED,
773 /** Success status code - END HERE.*/
775 /** Error status code - START HERE.*/
776 OC_STACK_INVALID_URI = 20,
777 OC_STACK_INVALID_QUERY,
779 OC_STACK_INVALID_PORT,
780 OC_STACK_INVALID_CALLBACK,
781 OC_STACK_INVALID_METHOD,
783 /** Invalid parameter.*/
784 OC_STACK_INVALID_PARAM,
785 OC_STACK_INVALID_OBSERVE_PARAM,
789 OC_STACK_ADAPTER_NOT_ENABLED,
792 /** Resource not found.*/
793 OC_STACK_NO_RESOURCE,
795 /** e.g: not supported method or interface.*/
796 OC_STACK_RESOURCE_ERROR,
797 OC_STACK_SLOW_RESOURCE,
798 OC_STACK_DUPLICATE_REQUEST,
800 /** Resource has no registered observers.*/
801 OC_STACK_NO_OBSERVERS,
802 OC_STACK_OBSERVER_NOT_FOUND,
803 OC_STACK_VIRTUAL_DO_NOT_HANDLE,
804 OC_STACK_INVALID_OPTION,
806 /** The remote reply contained malformed data.*/
807 OC_STACK_MALFORMED_RESPONSE,
808 OC_STACK_PERSISTENT_BUFFER_REQUIRED,
809 OC_STACK_INVALID_REQUEST_HANDLE,
810 OC_STACK_INVALID_DEVICE_INFO,
811 OC_STACK_INVALID_JSON,
813 /** Request is not authorized by Resource Server. */
814 OC_STACK_UNAUTHORIZED_REQ,
815 OC_STACK_TOO_LARGE_REQ,
817 /** Error code from PDM */
818 OC_STACK_PDM_IS_NOT_INITIALIZED,
819 OC_STACK_DUPLICATE_UUID,
820 OC_STACK_INCONSISTENT_DB,
823 * Error code from OTM
824 * This error is pushed from DTLS interface when handshake failure happens
826 OC_STACK_AUTHENTICATION_FAILURE,
828 /** Insert all new error codes here!.*/
830 OC_STACK_PRESENCE_STOPPED = 128,
831 OC_STACK_PRESENCE_TIMEOUT,
832 OC_STACK_PRESENCE_DO_NOT_HANDLE,
834 /** ERROR in stack.*/
836 /** Error status code - END HERE.*/
840 * Handle to an OCDoResource invocation.
842 typedef void * OCDoHandle;
845 * Handle to an OCResource object owned by the OCStack.
847 typedef void * OCResourceHandle;
850 * Handle to an OCRequest object owned by the OCStack.
852 typedef void * OCRequestHandle;
855 * Unique identifier for each observation request. Used when observations are
856 * registered or de-registered. Used by entity handler to signal specific
857 * observers to be notified of resource changes.
858 * There can be maximum of 256 observations per server.
860 typedef uint8_t OCObservationId;
863 * Action associated with observation.
868 OC_OBSERVE_REGISTER = 0,
870 /** To Deregister. */
871 OC_OBSERVE_DEREGISTER = 1,
874 OC_OBSERVE_NO_OPTION = 2,
877 OC_MQ_SUBSCRIBER = 3,
879 OC_MQ_UNSUBSCRIBER = 4,
886 * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
887 * when it calls OCRegisterPersistentStorageHandler.
888 * Persistent storage open handler points to default file path.
889 * It should check file path and whether the file is symbolic link or no.
890 * Application can point to appropriate SVR database path for it's IoTivity Server.
893 /** Persistent storage file path.*/
894 FILE* (* open)(const char *path, const char *mode);
896 /** Persistent storage read handler.*/
897 size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
899 /** Persistent storage write handler.*/
900 size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
902 /** Persistent storage close handler.*/
903 int (* close)(FILE *fp);
905 /** Persistent storage unlink handler.*/
906 int (* unlink)(const char *path);
907 } OCPersistentStorage;
910 * Possible returned values from entity handler.
914 /** Action associated with observation request.*/
915 OCObserveAction action;
917 /** Identifier for observation being registered/deregistered.*/
918 OCObservationId obsId;
922 * Possible returned values from entity handler.
928 OC_EH_RESOURCE_CREATED, // 2.01
929 OC_EH_RESOURCE_DELETED, // 2.02
931 OC_EH_FORBIDDEN, // 4.03
932 OC_EH_RESOURCE_NOT_FOUND, // 4.04
934 OC_EH_CHANGED, // 2.04
935 OC_EH_CONTENT, // 2.05
936 OC_EH_BAD_REQ, // 4.00
937 OC_EH_UNAUTHORIZED_REQ, // 4.01
938 OC_EH_BAD_OPT, // 4.02
939 OC_EH_METHOD_NOT_ALLOWED, // 4.05
940 OC_EH_NOT_ACCEPTABLE, // 4.06
941 OC_EH_INTERNAL_SERVER_ERROR, // 5.00
942 OC_EH_RETRANSMIT_TIMEOUT // 5.04
943 } OCEntityHandlerResult;
946 * This structure will be used to define the vendor specific header options to be included
947 * in communication packets.
949 typedef struct OCHeaderOption
951 /** The protocol ID this option applies to.*/
952 OCTransportProtocolID protocolID;
954 /** The header option ID which will be added to communication packets.*/
957 /** its length 191.*/
958 uint16_t optionLength;
960 /** pointer to its data.*/
961 uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
963 #ifdef SUPPORTS_DEFAULT_CTOR
964 OCHeaderOption() = default;
965 OCHeaderOption(OCTransportProtocolID pid,
968 const uint8_t* optData)
974 // parameter includes the null terminator.
975 optionLength = optionLength < MAX_HEADER_OPTION_DATA_LENGTH ?
976 optionLength : MAX_HEADER_OPTION_DATA_LENGTH;
977 memcpy(optionData, optData, optionLength);
978 optionData[optionLength - 1] = '\0';
985 * This structure describes the platform properties. All non-Null properties will be
986 * included in a platform discovery request.
993 /** Manufacturer name.*/
994 char *manufacturerName;
996 /** Manufacturer URL for platform property.*/
997 char *manufacturerUrl;
1002 /** Manufacturer date.*/
1003 char *dateOfManufacture;
1005 /** Platform version.*/
1006 char *platformVersion;
1008 /** Operating system version.*/
1009 char *operatingSystemVersion;
1012 char *hardwareVersion;
1015 char *firmwareVersion;
1017 /** Platform support URL.*/
1026 * This structure is expected as input for device properties.
1027 * device name is mandatory and expected from the application.
1028 * device id of type UUID will be generated by the stack.
1032 /** Pointer to the device name.*/
1034 /** Pointer to the types.*/
1036 /** Pointer to the device specification version.*/
1038 /** Pointer to the device data model versions (in CSV format).*/
1039 OCStringLL *dataModelVersions;
1044 * callback for bound JID
1046 typedef void (*jid_bound_cb)(char *jid);
1049 * CA Remote Access information for XMPP Client
1054 char *hostname; /**< XMPP server hostname */
1055 uint16_t port; /**< XMPP server serivce port */
1056 char *xmpp_domain; /**< XMPP login domain */
1057 char *username; /**< login username */
1058 char *password; /**< login password */
1059 char *resource; /**< specific resource for login */
1060 char *user_jid; /**< specific JID for login */
1061 jid_bound_cb jidbound; /**< callback when JID bound */
1063 #endif /* RA_ADAPTER */
1066 /** Enum to describe the type of object held by the OCPayload object.*/
1069 /** Contents of the payload are invalid */
1070 PAYLOAD_TYPE_INVALID,
1071 /** The payload is an OCDiscoveryPayload */
1072 PAYLOAD_TYPE_DISCOVERY,
1073 /** The payload is an OCDevicePayload */
1074 PAYLOAD_TYPE_DEVICE,
1075 /** The payload is an OCPlatformPayload */
1076 PAYLOAD_TYPE_PLATFORM,
1077 /** The payload is an OCRepPayload */
1078 PAYLOAD_TYPE_REPRESENTATION,
1079 /** The payload is an OCSecurityPayload */
1080 PAYLOAD_TYPE_SECURITY,
1081 /** The payload is an OCPresencePayload */
1082 PAYLOAD_TYPE_PRESENCE,
1083 /** The payload is an OCRDPayload */
1088 * A generic struct representing a payload returned from a resource operation
1090 * A pointer to OCPayLoad can be cast to a more specific struct to access members
1095 /** The type of message that was received */
1106 OCREP_PROP_BYTE_STRING,
1109 }OCRepPayloadPropType;
1111 /** This structure will be used to represent a binary string for CBOR payloads.*/
1114 /** pointer to data bytes.*/
1117 /** number of data bytes.*/
1121 #define MAX_REP_ARRAY_DEPTH 3
1124 OCRepPayloadPropType type;
1125 size_t dimensions[MAX_REP_ARRAY_DEPTH];
1134 /** pointer to ByteString array.*/
1135 OCByteString* ocByteStrArray;
1137 struct OCRepPayload** objArray;
1139 } OCRepPayloadValueArray;
1141 typedef struct OCRepPayloadValue
1144 OCRepPayloadPropType type;
1152 /** ByteString object.*/
1153 OCByteString ocByteStr;
1155 struct OCRepPayload* obj;
1156 OCRepPayloadValueArray arr;
1158 struct OCRepPayloadValue* next;
1160 } OCRepPayloadValue;
1162 // used for get/set/put/observe/etc representations
1163 typedef struct OCRepPayload
1168 OCStringLL* interfaces;
1169 OCRepPayloadValue* values;
1170 struct OCRepPayload* next;
1173 // used inside a discovery payload
1174 typedef struct OCResourcePayload
1178 OCStringLL* interfaces;
1185 struct OCResourcePayload* next;
1186 } OCResourcePayload;
1189 * Structure holding Links Payload. It is a sub-structure used in
1190 * OCResourceCollectionPayload.
1192 typedef struct OCLinksPayload
1194 /** This is the target relative URI. */
1196 /** Resource Type - A standard OIC specified or vendor defined resource
1197 * type of the resource referenced by the target URI. */
1199 /** Interface - The interfaces supported by the resource referenced by the target URI. */
1201 /** The relation of the target URI referenced by the link to the context URI;
1202 * The default value is null. */
1204 /** Specifies if the resource referenced by the target URIis observable or not. */
1206 /** A title for the link relation. Can be used by the UI to provide a context. */
1208 /** This is used to override the context URI e.g. override the URI of the containing collection. */
1210 /** The instance identifier for this web link in an array of web links - used in links. */
1213 /** An ordinal number that is not repeated - must be unique in the collection context. */
1215 /** Any unique string including a URI. */
1217 /** Use UUID for universal uniqueness - used in /oic/res to identify the device. */
1218 OCIdentity uniqueUUID;
1220 /** A hint of the media type of the representation of the resource referenced by the target URI. */
1222 /** Holding address of the next resource. */
1223 struct OCLinksPayload *next;
1226 /** Structure holding tags value of the links payload. */
1229 /** Name of tags. */
1231 /** Device identifier. */
1233 /** The base URI where the resources are hold. */
1235 /** Bitmap holds observable, discoverable, secure option flag.*/
1237 /** Port set in case, the secure flag is set above. */
1239 /** Id for each set of links i.e. tag. */
1242 /** An ordinal number that is not repeated - must be unique in the collection context. */
1244 /** Any unique string including a URI. */
1246 /** Use UUID for universal uniqueness - used in /oic/res to identify the device. */
1247 OCIdentity uniqueUUID;
1249 /** Defines the list of allowable resource types (for Target and anchors) in links included
1250 * in the collection; new links being created can only be from this list. */
1252 /** When specified this is the default relationship to use when an OIC Link does not specify
1253 * an explicit relationship with *rel* parameter. */
1255 /** Time to keep holding resource.*/
1259 /** Resource collection payload. */
1260 typedef struct OCResourceCollectionPayload
1262 /** Collection tags payload.*/
1263 OCTagsPayload *tags;
1264 /** Array of links payload. */
1265 OCLinksPayload *setLinks;
1266 /** Holding address of the next resource. */
1267 struct OCResourceCollectionPayload *next;
1268 } OCResourceCollectionPayload;
1270 typedef struct OCDiscoveryPayload
1277 /** A special case for handling RD address. */
1286 /** Resource Type */
1292 /** This structure holds the old /oic/res response. */
1293 OCResourcePayload *resources;
1295 /** Holding address of the next DiscoveryPayload. */
1296 struct OCDiscoveryPayload *next;
1298 } OCDiscoveryPayload;
1301 * Structure holding discovery payload.
1307 /** Device Identity. */
1309 /** Value holding the bias factor of the RD. */
1311 } OCRDDiscoveryPayload;
1314 * RD Payload that will be transmitted over the wire.
1319 /** Pointer to the discovery response payload.*/
1320 OCRDDiscoveryPayload *rdDiscovery;
1321 /** Pointer to the publish payload.*/
1322 OCResourceCollectionPayload *rdPublish;
1331 OCStringLL *dataModelVersions;
1332 OCStringLL *interfaces;
1340 OCPlatformInfo info;
1342 OCStringLL* interfaces;
1343 } OCPlatformPayload;
1348 uint8_t* securityData;
1350 } OCSecurityPayload;
1352 #ifdef WITH_PRESENCE
1356 uint32_t sequenceNumber;
1358 OCPresenceTrigger trigger;
1360 } OCPresencePayload;
1364 * Incoming requests handled by the server. Requests are passed in as a parameter to the
1365 * OCEntityHandler callback API.
1366 * The OCEntityHandler callback API must be implemented in the application in order
1367 * to receive these requests.
1371 /** Associated resource.*/
1372 OCResourceHandle resource;
1374 /** Associated request handle.*/
1375 OCRequestHandle requestHandle;
1377 /** the REST method retrieved from received request PDU.*/
1380 /** description of endpoint that sent the request.*/
1383 /** resource query send by client.*/
1386 /** Information associated with observation - valid only when OCEntityHandler flag includes
1387 * ::OC_OBSERVE_FLAG.*/
1388 OCObservationInfo obsInfo;
1390 /** Number of the received vendor specific header options.*/
1391 uint8_t numRcvdVendorSpecificHeaderOptions;
1393 /** Pointer to the array of the received vendor specific header options.*/
1394 OCHeaderOption * rcvdVendorSpecificHeaderOptions;
1399 /** the payload from the request PDU.*/
1402 } OCEntityHandlerRequest;
1406 * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
1410 /** Address of remote server.*/
1413 /** backward compatibility (points to devAddr).*/
1416 /** backward compatibility.*/
1417 OCConnectivityType connType;
1419 /** the security identity of the remote server.*/
1420 OCIdentity identity;
1422 /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
1423 OCStackResult result;
1425 /** If associated with observe, this will represent the sequence of notifications from server.*/
1426 uint32_t sequenceNumber;
1429 const char * resourceUri;
1431 /** the payload for the response PDU.*/
1434 /** Number of the received vendor specific header options.*/
1435 uint8_t numRcvdVendorSpecificHeaderOptions;
1437 /** An array of the received vendor specific header options.*/
1438 OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1442 * Request handle is passed to server via the entity handler for each incoming request.
1443 * Stack assigns when request is received, server sets to indicate what request response is for.
1447 /** Request handle.*/
1448 OCRequestHandle requestHandle;
1450 /** Resource handle.*/
1451 OCResourceHandle resourceHandle;
1453 /** Allow the entity handler to pass a result with the response.*/
1454 OCEntityHandlerResult ehResult;
1456 /** This is the pointer to server payload data to be transferred.*/
1459 /** number of the vendor specific header options .*/
1460 uint8_t numSendVendorSpecificHeaderOptions;
1462 /** An array of the vendor specific header options the entity handler wishes to use in response.*/
1463 OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1465 /** URI of new resource that entity handler might create.*/
1466 char resourceUri[MAX_URI_LENGTH];
1468 /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
1469 uint8_t persistentBufferFlag;
1470 } OCEntityHandlerResponse;
1477 /** Request state.*/
1478 OC_REQUEST_FLAG = (1 << 1),
1479 /** Observe state.*/
1480 OC_OBSERVE_FLAG = (1 << 2)
1481 } OCEntityHandlerFlag;
1484 * Possible return values from client application callback
1486 * A client application callback returns an OCStackApplicationResult to indicate whether
1487 * the stack should continue to keep the callback registered.
1491 /** Make no more calls to the callback and call the OCClientContextDeleter for this callback */
1492 OC_STACK_DELETE_TRANSACTION = 0,
1493 /** Keep this callback registered and call it if an apropriate event occurs */
1494 OC_STACK_KEEP_TRANSACTION
1495 } OCStackApplicationResult;
1498 //#ifdef DIRECT_PAIRING
1500 * @brief direct pairing Method Type.
1502 * 1: pre-configured pin
1507 DP_NOT_ALLOWED = 0x0,
1508 DP_PRE_CONFIGURED = (0x1 << 0),
1509 DP_RANDOM_PIN = (0x1 << 1),
1513 * Device Information of discoverd direct pairing device(s).
1515 typedef struct OCDPDev
1518 OCConnectivityType connType;
1519 uint16_t securePort;
1523 OCUUIdentity deviceID;
1524 OCUUIdentity rowner;
1525 struct OCDPDev *next;
1527 //#endif // DIRECT_PAIRING
1530 * -------------------------------------------------------------------------------------------
1531 * Callback function definitions
1532 * -------------------------------------------------------------------------------------------
1536 * Client applications implement this callback to consume responses received from Servers.
1538 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
1539 OCClientResponse * clientResponse);
1542 * Client applications using a context pointer implement this callback to delete the
1543 * context upon removal of the callback/context pointer from the internal callback-list.
1545 typedef void (* OCClientContextDeleter)(void *context);
1548 * This info is passed from application to OC Stack when initiating a request to Server.
1550 typedef struct OCCallbackData
1552 /** Pointer to the context.*/
1555 /** The pointer to a function the stack will call to handle the requests.*/
1556 OCClientResponseHandler cb;
1558 /** A pointer to a function to delete the context when this callback is removed.*/
1559 OCClientContextDeleter cd;
1561 #ifdef SUPPORTS_DEFAULT_CTOR
1562 OCCallbackData() = default;
1563 OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
1564 :context(ctx), cb(callback), cd(deleter){}
1569 * Application server implementations must implement this callback to consume requests OTA.
1570 * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
1572 typedef OCEntityHandlerResult (*OCEntityHandler)
1573 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, void* callbackParam);
1576 * Device Entity handler need to use this call back instead of OCEntityHandler.
1578 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
1579 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri, void* callbackParam);
1581 //#ifdef DIRECT_PAIRING
1583 * Callback function definition of direct-pairing
1585 * @param[OUT] ctx - user context returned in the callback.
1586 * @param[OUT] peer - pairing device info.
1587 * @param[OUT} result - It's returned with 'OC_STACK_XXX'. It will return 'OC_STACK_OK'
1588 * if D2D pairing is success without error
1590 typedef void (*OCDirectPairingCB)(void *ctx, OCDPDev_t *peer, OCStackResult result);
1591 //#endif // DIRECT_PAIRING
1595 #endif // __cplusplus
1597 #endif /* OCTYPES_H_ */