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 "ocstackconfig.h"
41 /** For the feature presence.*/
44 #include "ocpresence.h"
45 //-----------------------------------------------------------------------------
47 //-----------------------------------------------------------------------------
50 * OIC Virtual resources supported by every OIC device.
53 * Default discovery mechanism using '/oic/res' is supported by all OIC devices
54 * That are Discoverable.
56 #define OC_RSRVD_WELL_KNOWN_URI "/oic/res"
59 #define OC_RSRVD_DEVICE_URI "/oic/d"
62 #define OC_RSRVD_PLATFORM_URI "/oic/p"
65 #define OC_RSRVD_RESOURCE_TYPES_URI "/oic/res/types/d"
69 /** Presence URI through which the OIC devices advertise their presence.*/
70 #define OC_RSRVD_PRESENCE_URI "/oic/ad"
72 /** Sets the default time to live (TTL) for presence.*/
73 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
75 /** For multicast Discovery mechanism.*/
76 #define OC_MULTICAST_DISCOVERY_URI "/oic/res"
78 /** Separator for multiple query string.*/
79 #define OC_QUERY_SEPARATOR "&;"
82 * OC_DEFAULT_PRESENCE_TTL_SECONDS sets the default time to live (TTL) for presence.
84 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
87 * OC_MAX_PRESENCE_TTL_SECONDS sets the maximum time to live (TTL) for presence.
88 * NOTE: Changing the setting to a longer duration may lead to unsupported and untested
90 * 60 sec/min * 60 min/hr * 24 hr/day
92 #define OC_MAX_PRESENCE_TTL_SECONDS (60 * 60 * 24)
96 * Presence "Announcement Triggers".
100 #define OC_RSRVD_TRIGGER_CREATE "create"
103 #define OC_RSRVD_TRIGGER_CHANGE "change"
106 #define OC_RSRVD_TRIGGER_DELETE "delete"
109 * Attributes used to form a proper OIC conforming JSON message.
112 #define OC_RSRVD_OC "oic"
116 #define OC_RSRVD_PAYLOAD "payload"
118 /** To represent href */
119 #define OC_RSRVD_HREF "href"
121 /** To represent property*/
122 #define OC_RSRVD_PROPERTY "prop"
124 /** For representation.*/
125 #define OC_RSRVD_REPRESENTATION "rep"
127 /** To represent content type.*/
128 #define OC_RSRVD_CONTENT_TYPE "ct"
130 /** To represent resource type.*/
131 #define OC_RSRVD_RESOURCE_TYPE "rt"
133 /** To represent resource type with presence.*/
134 #define OC_RSRVD_RESOURCE_TYPE_PRESENCE "oic.wk.ad"
136 /** To represent interface.*/
137 #define OC_RSRVD_INTERFACE "if"
139 /** To represent time to live.*/
140 #define OC_RSRVD_TTL "ttl"
142 /** To represent non*/
143 #define OC_RSRVD_NONCE "non"
145 /** To represent trigger type.*/
146 #define OC_RSRVD_TRIGGER "trg"
148 /** To represent links.*/
149 #define OC_RSRVD_LINKS "links"
151 /** To represent default interface.*/
152 #define OC_RSRVD_INTERFACE_DEFAULT "oic.if.baseline"
154 /** To represent ll interface.*/
155 #define OC_RSRVD_INTERFACE_LL "oic.if.ll"
157 /** To represent batch interface.*/
158 #define OC_RSRVD_INTERFACE_BATCH "oic.if.b"
160 /** To represent interface group.*/
161 #define OC_RSRVD_INTERFACE_GROUP "oic.mi.grp"
163 /** To represent MFG date.*/
164 #define OC_RSRVD_MFG_DATE "mndt"
166 /** To represent FW version.*/
167 #define OC_RSRVD_FW_VERSION "mnfv"
169 /** To represent host name.*/
170 #define OC_RSRVD_HOST_NAME "hn"
172 /** To represent version.*/
173 #define OC_RSRVD_VERSION "icv"
175 /** To represent policy.*/
176 #define OC_RSRVD_POLICY "p"
178 /** To represent bitmap.*/
179 #define OC_RSRVD_BITMAP "bm"
182 #define OC_RSRVD_SECURE "sec"
185 #define OC_RSRVD_HOSTING_PORT "port"
187 /** For Server instance ID.*/
188 #define OC_RSRVD_SERVER_INSTANCE_ID "sid"
195 #define OC_RSRVD_PLATFORM_ID "pi"
197 /** Platform MFG NAME. */
198 #define OC_RSRVD_MFG_NAME "mnmn"
201 #define OC_RSRVD_MFG_URL "mnml"
204 #define OC_RSRVD_MODEL_NUM "mnmo"
206 /** Platform MFG Date.*/
207 #define OC_RSRVD_MFG_DATE "mndt"
209 /** Platform versio.n */
210 #define OC_RSRVD_PLATFORM_VERSION "mnpv"
212 /** Platform Operating system version. */
213 #define OC_RSRVD_OS_VERSION "mnos"
215 /** Platform Hardware version. */
216 #define OC_RSRVD_HARDWARE_VERSION "mnhw"
218 /**Platform Firmware version. */
219 #define OC_RSRVD_FIRMWARE_VERSION "mnfv"
221 /** Support URL for the platform. */
222 #define OC_RSRVD_SUPPORT_URL "mnsl"
224 /** System time for the platform. */
225 #define OC_RSRVD_SYSTEM_TIME "st"
232 #define OC_RSRVD_DEVICE_ID "di"
235 #define OC_RSRVD_DEVICE_NAME "n"
237 /** Device specification version.*/
238 #define OC_RSRVD_SPEC_VERSION "lcv"
240 /** Device data model.*/
241 #define OC_RSRVD_DATA_MODEL_VERSION "dmv"
243 /** Device specification version.*/
244 #define OC_SPEC_VERSION "0.9.0"
246 /** Device Data Model version.*/
247 #define OC_DATA_MODEL_VERSION "sec.0.95"
250 * These provide backward compatibility - their use is deprecated.
254 /** Multicast Prefix.*/
255 #define OC_MULTICAST_PREFIX "224.0.1.187:5683"
257 /** Multicast IP address.*/
258 #define OC_MULTICAST_IP "224.0.1.187"
260 /** Multicast Port.*/
261 #define OC_MULTICAST_PORT 5683
265 #define MAX_ADDR_STR_SIZE (256)
267 #define MAX_ADDR_STR_SIZE (40)
270 #define MAX_IDENTITY_SIZE (32)
272 /** Max Device address size. */
273 #define MAX_ADDR_STR_SIZE (40)
275 /** Max identity size. */
276 #define MAX_IDENTITY_SIZE (32)
279 * These enums (OCTransportAdapter and OCTransportFlags) must
280 * be kept synchronized with OCConnectivityType (below) as well as
281 * CATransportAdapter and CATransportFlags (in CACommon.h).
285 /** value zero indicates discovery.*/
286 OC_DEFAULT_ADAPTER = 0,
288 /** IPv4 and IPv6, including 6LoWPAN.*/
289 OC_ADAPTER_IP = (1 << 0),
291 /** GATT over Bluetooth LE.*/
292 OC_ADAPTER_GATT_BTLE = (1 << 1),
294 /** RFCOMM over Bluetooth EDR.*/
295 OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
298 /**Remote Access over XMPP.*/
299 OC_ADAPTER_REMOTE_ACCESS = (1 << 3)
302 } OCTransportAdapter;
305 * Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
309 /** default flag is 0*/
310 OC_DEFAULT_FLAGS = 0,
312 /** Insecure transport is the default (subject to change).*/
313 /** secure the transport path*/
314 OC_FLAG_SECURE = (1 << 4),
316 /** IPv4 & IPv6 auto-selection is the default.*/
317 /** IP adapter only.*/
318 OC_IP_USE_V6 = (1 << 5),
320 /** IP adapter only.*/
321 OC_IP_USE_V4 = (1 << 6),
323 /** internal use only.*/
324 OC_RESERVED1 = (1 << 7), // internal use only
326 /** Link-Local multicast is the default multicast scope for IPv6.
327 * These are placed here to correspond to the IPv6 multicast address bits.*/
329 /** IPv6 Interface-Local scope (loopback).*/
330 OC_SCOPE_INTERFACE = 0x1,
332 /** IPv6 Link-Local scope (default).*/
335 /** IPv6 Realm-Local scope. */
336 OC_SCOPE_REALM = 0x3,
338 /** IPv6 Admin-Local scope. */
339 OC_SCOPE_ADMIN = 0x4,
341 /** IPv6 Site-Local scope. */
344 /** IPv6 Organization-Local scope. */
347 /**IPv6 Global scope. */
348 OC_SCOPE_GLOBAL = 0xE,
352 /** Bit mask for scope.*/
353 #define OC_MASK_SCOPE (0x000F)
355 /** Bit mask for Mods.*/
356 #define OC_MASK_MODS (0x0FF0)
357 #define OC_MASK_FAMS (OC_IP_USE_V6|OC_IP_USE_V4)
360 * End point identity.
364 /** Identity Length */
367 /** Array of end point identity.*/
368 unsigned char id[MAX_IDENTITY_SIZE];
372 * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
373 * OCDevAddr must be the same as CAEndpoint (in CACommon.h).
378 OCTransportAdapter adapter;
380 /** transport modifiers.*/
381 OCTransportFlags flags;
383 /** address for all adapters.*/
384 char addr[MAX_ADDR_STR_SIZE];
386 /** usually zero for default interface.*/
392 /** secure node identity.*/
397 * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
398 * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
399 * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
402 * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
406 /** use when defaults are ok. */
410 #if defined (__UINT32_MAX__) && (__UINT32_MAX__ == 65535)
412 /** IPv4 and IPv6, including 6LoWPAN.*/
413 CT_ADAPTER_IP = (1 << 10),
415 /** GATT over Bluetooth LE.*/
416 CT_ADAPTER_GATT_BTLE = (1 << 11),
418 /** RFCOMM over Bluetooth EDR.*/
419 CT_ADAPTER_RFCOMM_BTEDR = (1 << 12),
421 /** assume 32-bit int. */
424 /** IPv4 and IPv6, including 6LoWPAN.*/
425 CT_ADAPTER_IP = (1 << 16),
427 /** GATT over Bluetooth LE.*/
428 CT_ADAPTER_GATT_BTLE = (1 << 17),
430 /** RFCOMM over Bluetooth EDR.*/
431 CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
434 /** Remote Access over XMPP.*/
435 CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
438 /** bit shift required for connectivity adapter.*/
439 #define CT_ADAPTER_SHIFT 10
442 #define CT_MASK_FLAGS 0x03FF
445 #define CT_MASK_ADAPTER 0xFC00
449 /** Insecure transport is the default (subject to change).*/
451 /** secure the transport path.*/
452 CT_FLAG_SECURE = (1 << 4),
454 /** IPv4 & IPv6 autoselection is the default.*/
456 /** IP adapter only.*/
457 CT_IP_USE_V6 = (1 << 5),
459 /** IP adapter only.*/
460 CT_IP_USE_V4 = (1 << 6),
462 /** Link-Local multicast is the default multicast scope for IPv6.
463 * These are placed here to correspond to the IPv6 address bits.*/
465 /** IPv6 Interface-Local scope(loopback).*/
466 CT_SCOPE_INTERFACE = 0x1,
468 /** IPv6 Link-Local scope (default).*/
471 /** IPv6 Realm-Local scope.*/
472 CT_SCOPE_REALM = 0x3,
474 /** IPv6 Admin-Local scope.*/
475 CT_SCOPE_ADMIN = 0x4,
477 /** IPv6 Site-Local scope.*/
480 /** IPv6 Organization-Local scope.*/
483 /** IPv6 Global scope.*/
484 CT_SCOPE_GLOBAL = 0xE,
485 } OCConnectivityType;
488 * OCDoResource methods to dispatch the request
492 OC_REST_NOMETHOD = 0,
495 OC_REST_GET = (1 << 0),
498 OC_REST_PUT = (1 << 1),
501 OC_REST_POST = (1 << 2),
504 OC_REST_DELETE = (1 << 3),
506 /** Register observe request for most up date notifications ONLY.*/
507 OC_REST_OBSERVE = (1 << 4),
509 /** Register observe request for all notifications, including stale notifications.*/
510 OC_REST_OBSERVE_ALL = (1 << 5),
512 /** De-register observation, intended for internal use.*/
513 OC_REST_CANCEL_OBSERVE = (1 << 6),
516 /** Subscribe for all presence notifications of a particular resource.*/
517 OC_REST_PRESENCE = (1 << 7),
520 /** Allows OCDoResource caller to do discovery.*/
521 OC_REST_DISCOVER = (1 << 8)
525 * Host Mode of Operation.
535 * Quality of Service attempts to abstract the guarantees provided by the underlying transport
536 * protocol. The precise definitions of each quality of service level depend on the
537 * implementation. In descriptions below are for the current implementation and may changed
542 /** Packet delivery is best effort.*/
545 /** Packet delivery is best effort.*/
548 /** Acknowledgments are used to confirm delivery.*/
551 /** No Quality is defined, let the stack decide.*/
553 } OCQualityOfService;
556 * Resource Properties.
557 * The value of a policy property is defined as bitmap.
558 * The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
559 * Not including the policy property is equivalent to zero.
561 * ::OC_RES_PROP_NONE When none of the bits are set, the resource is non-discoverable &
562 * non-observable by the client.
563 * ::OC_DISCOVERABLE When this bit is set, the resource is allowed to be discovered by clients.
564 * ::OC_OBSERVABLE When this bit is set, the resource is allowed to be observed by clients.
569 /** When none of the bits are set, the resource is non-discoverable &
570 * non-observable by the client.*/
571 OC_RES_PROP_NONE = (0),
573 /** When this bit is set, the resource is allowed to be discovered by clients.*/
574 OC_DISCOVERABLE = (1 << 0),
576 /** When this bit is set, the resource is allowed to be observed by clients.*/
577 OC_OBSERVABLE = (1 << 1),
579 /** When this bit is set, the resource is initialized, otherwise the resource
580 * is 'inactive'. 'inactive' signifies that the resource has been marked for
581 * deletion or is already deleted.*/
582 OC_ACTIVE = (1 << 2),
584 /** When this bit is set, the resource has been marked as 'slow'.
585 * 'slow' signifies that responses from this resource can expect delays in
586 * processing its requests from clients.*/
589 /** When this bit is set, the resource is a secure resource.*/
591 } OCResourceProperty;
594 * Transport Protocol IDs.
598 /** For invalid ID.*/
599 OC_INVALID_ID = (1 << 0),
602 OC_COAP_ID = (1 << 1)
603 } OCTransportProtocolID;
606 * Declares Stack Results & Errors.
610 /** Success status code - START HERE.*/
612 OC_STACK_RESOURCE_CREATED,
613 OC_STACK_RESOURCE_DELETED,
615 /** Success status code - END HERE.*/
617 /** Error status code - START HERE.*/
618 OC_STACK_INVALID_URI = 20,
619 OC_STACK_INVALID_QUERY,
621 OC_STACK_INVALID_PORT,
622 OC_STACK_INVALID_CALLBACK,
623 OC_STACK_INVALID_METHOD,
625 /** Invalid parameter.*/
626 OC_STACK_INVALID_PARAM,
627 OC_STACK_INVALID_OBSERVE_PARAM,
631 OC_STACK_ADAPTER_NOT_ENABLED,
634 /** Resource not found.*/
635 OC_STACK_NO_RESOURCE,
637 /** e.g: not supported method or interface.*/
638 OC_STACK_RESOURCE_ERROR,
639 OC_STACK_SLOW_RESOURCE,
640 OC_STACK_DUPLICATE_REQUEST,
642 /** Resource has no registered observers.*/
643 OC_STACK_NO_OBSERVERS,
644 OC_STACK_OBSERVER_NOT_FOUND,
645 OC_STACK_VIRTUAL_DO_NOT_HANDLE,
646 OC_STACK_INVALID_OPTION,
648 /** The remote reply contained malformed data.*/
649 OC_STACK_MALFORMED_RESPONSE,
650 OC_STACK_PERSISTENT_BUFFER_REQUIRED,
651 OC_STACK_INVALID_REQUEST_HANDLE,
652 OC_STACK_INVALID_DEVICE_INFO,
653 OC_STACK_INVALID_JSON,
655 /** Request is not authorized by Resource Server. */
656 OC_STACK_UNAUTHORIZED_REQ,
658 /** Insert all new error codes here!.*/
660 OC_STACK_PRESENCE_STOPPED = 128,
661 OC_STACK_PRESENCE_TIMEOUT,
662 OC_STACK_PRESENCE_DO_NOT_HANDLE,
664 /** ERROR in stack.*/
666 /** Error status code - END HERE.*/
670 * Handle to an OCDoResource invocation.
672 typedef void * OCDoHandle;
675 * Handle to an OCResource object owned by the OCStack.
677 typedef void * OCResourceHandle;
680 * Handle to an OCRequest object owned by the OCStack.
682 typedef void * OCRequestHandle;
685 * Unique identifier for each observation request. Used when observations are
686 * registered or de-registered. Used by entity handler to signal specific
687 * observers to be notified of resource changes.
688 * There can be maximum of 256 observations per server.
690 typedef uint8_t OCObservationId;
693 * Action associated with observation.
698 OC_OBSERVE_REGISTER = 0,
700 /** To Deregister. */
701 OC_OBSERVE_DEREGISTER = 1,
704 OC_OBSERVE_NO_OPTION = 2
709 * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
710 * when it calls OCRegisterPersistentStorageHandler.
711 * Persistent storage open handler points to default file path.
712 * Application can point to appropriate SVR database path for it's IoTivity Server.
715 /** Persistent storage file path.*/
716 FILE* (* open)(const char *path, const char *mode);
718 /** Persistent storage read handler.*/
719 size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
721 /** Persistent storage write handler.*/
722 size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
724 /** Persistent storage close handler.*/
725 int (* close)(FILE *fp);
727 /** Persistent storage unlink handler.*/
728 int (* unlink)(const char *path);
729 } OCPersistentStorage;
732 * Possible returned values from entity handler.
736 /** Action associated with observation request.*/
737 OCObserveAction action;
739 /** Identifier for observation being registered/deregistered.*/
740 OCObservationId obsId;
744 * Possible returned values from entity handler.
750 OC_EH_RESOURCE_CREATED,
751 OC_EH_RESOURCE_DELETED,
754 OC_EH_RESOURCE_NOT_FOUND
755 } OCEntityHandlerResult;
758 * This structure will be used to define the vendor specific header options to be included
759 * in communication packets.
761 typedef struct OCHeaderOption
763 /** The protocol ID this option applies to.*/
764 OCTransportProtocolID protocolID;
766 /** The header option ID which will be added to communication packets.*/
769 /** its length 191.*/
770 uint16_t optionLength;
772 /** pointer to its data.*/
773 uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
776 OCHeaderOption() = default;
777 OCHeaderOption(OCTransportProtocolID pid,
780 const uint8_t* optData)
786 // parameter includes the null terminator.
787 optionLength = optionLength < MAX_HEADER_OPTION_DATA_LENGTH ?
788 optionLength : MAX_HEADER_OPTION_DATA_LENGTH;
789 memcpy(optionData, optData, optionLength);
790 optionData[optionLength - 1] = '\0';
797 * This structure describes the platform properties. All non-Null properties will be
798 * included in a platform discovery request.
805 /** Manufacturer name.*/
806 char *manufacturerName;
808 /** Manufacturer URL for platform property.*/
809 char *manufacturerUrl;
814 /** Manufacturer date.*/
815 char *dateOfManufacture;
817 /** Platform version.*/
818 char *platformVersion;
820 /** Operating system version.*/
821 char *operatingSystemVersion;
824 char *hardwareVersion;
827 char *firmwareVersion;
829 /** Platform support URL.*/
838 * This structure is expected as input for device properties.
839 * device name is mandatory and expected from the application.
840 * device id of type UUID will be generated by the stack.
844 /** Pointer to the device name.*/
851 * CA Remote Access information for XMPP Client
856 char *hostname; /**< XMPP server hostname */
857 uint16_t port; /**< XMPP server serivce port */
858 char *xmpp_domain; /**< XMPP login domain */
859 char *username; /**< login username */
860 char *password; /**< login password */
861 char *resource; /**< specific resource for login */
862 char *user_jid; /**< specific JID for login */
864 #endif /* RA_ADAPTER */
867 /** Enum to describe the type of object held by the OCPayload object.*/
870 PAYLOAD_TYPE_INVALID,
871 PAYLOAD_TYPE_DISCOVERY,
873 PAYLOAD_TYPE_PLATFORM,
874 PAYLOAD_TYPE_REPRESENTATION,
875 PAYLOAD_TYPE_SECURITY,
876 PAYLOAD_TYPE_PRESENCE
881 // The type of message that was received
894 }OCRepPayloadPropType;
896 #define MAX_REP_ARRAY_DEPTH 3
899 OCRepPayloadPropType type;
900 size_t dimensions[MAX_REP_ARRAY_DEPTH];
908 struct OCRepPayload** objArray;
910 } OCRepPayloadValueArray;
912 typedef struct OCRepPayloadValue
915 OCRepPayloadPropType type;
922 struct OCRepPayload* obj;
923 OCRepPayloadValueArray arr;
925 struct OCRepPayloadValue* next;
929 typedef struct OCStringLL
931 struct OCStringLL *next;
935 // used for get/set/put/observe/etc representations
936 typedef struct OCRepPayload
941 OCStringLL* interfaces;
942 OCRepPayloadValue* values;
943 struct OCRepPayload* next;
946 // used inside a discovery payload
947 typedef struct OCResourcePayload
952 OCStringLL* interfaces;
956 struct OCResourcePayload* next;
962 OCResourcePayload* resources;
963 } OCDiscoveryPayload;
972 char* dataModelVersion;
991 uint32_t sequenceNumber;
993 OCPresenceTrigger trigger;
999 * Incoming requests handled by the server. Requests are passed in as a parameter to the
1000 * OCEntityHandler callback API.
1001 * The OCEntityHandler callback API must be implemented in the application in order
1002 * to receive these requests.
1006 /** Associated resource.*/
1007 OCResourceHandle resource;
1009 /** Associated request handle.*/
1010 OCRequestHandle requestHandle;
1012 /** the REST method retrieved from received request PDU.*/
1015 /** description of endpoint that sent the request.*/
1018 /** resource query send by client.*/
1021 /** Information associated with observation - valid only when OCEntityHandler flag includes
1022 * ::OC_OBSERVE_FLAG.*/
1023 OCObservationInfo obsInfo;
1025 /** Number of the received vendor specific header options.*/
1026 uint8_t numRcvdVendorSpecificHeaderOptions;
1028 /** Pointer to the array of the received vendor specific header options.*/
1029 OCHeaderOption * rcvdVendorSpecificHeaderOptions;
1031 /** the payload from the request PDU.*/
1035 } OCEntityHandlerRequest;
1039 * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
1043 /** Address of remote server.*/
1046 /** backward compatibility (points to devAddr).*/
1049 /** backward compatibility.*/
1050 OCConnectivityType connType;
1052 /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
1053 OCStackResult result;
1055 /** If associated with observe, this will represent the sequence of notifications from server.*/
1056 uint32_t sequenceNumber;
1059 const char * resourceUri;
1061 /** the payload for the response PDU.*/
1064 /** Number of the received vendor specific header options.*/
1065 uint8_t numRcvdVendorSpecificHeaderOptions;
1067 /** An array of the received vendor specific header options.*/
1068 OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1072 * Request handle is passed to server via the entity handler for each incoming request.
1073 * Stack assigns when request is received, server sets to indicate what request response is for.
1077 /** Request handle.*/
1078 OCRequestHandle requestHandle;
1080 /** Resource handle.*/
1081 OCResourceHandle resourceHandle;
1083 /** Allow the entity handler to pass a result with the response.*/
1084 OCEntityHandlerResult ehResult;
1086 /** This is the pointer to server payload data to be transferred.*/
1089 /** number of the vendor specific header options .*/
1090 uint8_t numSendVendorSpecificHeaderOptions;
1092 /** An array of the vendor specific header options the entity handler wishes to use in response.*/
1093 OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1095 /** URI of new resource that entity handler might create.*/
1096 char resourceUri[MAX_URI_LENGTH];
1098 /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
1099 uint8_t persistentBufferFlag;
1100 } OCEntityHandlerResponse;
1107 /** Request state.*/
1108 OC_REQUEST_FLAG = (1 << 1),
1109 /** Observe state.*/
1110 OC_OBSERVE_FLAG = (1 << 2)
1111 } OCEntityHandlerFlag;
1114 * Possible returned values from client application.
1118 OC_STACK_DELETE_TRANSACTION = 0,
1119 OC_STACK_KEEP_TRANSACTION
1120 } OCStackApplicationResult;
1124 * -------------------------------------------------------------------------------------------
1125 * Callback function definitions
1126 * -------------------------------------------------------------------------------------------
1130 * Client applications implement this callback to consume responses received from Servers.
1132 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
1133 OCClientResponse * clientResponse);
1136 * Client applications using a context pointer implement this callback to delete the
1137 * context upon removal of the callback/context pointer from the internal callback-list.
1139 typedef void (* OCClientContextDeleter)(void *context);
1142 * This info is passed from application to OC Stack when initiating a request to Server.
1144 typedef struct OCCallbackData
1146 /** Pointer to the context.*/
1149 /** The pointer to a function the stack will call to handle the requests.*/
1150 OCClientResponseHandler cb;
1152 /** A pointer to a function to delete the context when this callback is removed.*/
1153 OCClientContextDeleter cd;
1156 OCCallbackData() = default;
1157 OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
1158 :context(ctx), cb(callback), cd(deleter){}
1163 * Application server implementations must implement this callback to consume requests OTA.
1164 * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
1166 typedef OCEntityHandlerResult (*OCEntityHandler)
1167 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, void* callbackParam);
1170 * Device Entity handler need to use this call back instead of OCEntityHandler.
1172 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
1173 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri, void* callbackParam);
1177 #endif // __cplusplus
1179 #endif /* OCTYPES_H_ */