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 #include "ocstackconfig.h"
31 //-----------------------------------------------------------------------------
33 //-----------------------------------------------------------------------------
35 //TODO: May want to refactor this in upcoming sprints.
36 //Don't want to expose to application layer that lower level stack is using CoAP.
38 #define OC_WELL_KNOWN_QUERY "224.0.1.187:5683/oc/core"
39 #define OC_EXPLICIT_DEVICE_DISCOVERY_URI "224.0.1.187:5683/oc/core/d?rt=core.led"
40 #define OC_MULTICAST_PREFIX "224.0.1.187:5683"
41 #define OC_MULTICAST_IP "224.0.1.187"
42 #define OC_MULTICAST_PORT 5683
45 #define OC_DEFAULT_PRESENCE_TTL (60)
46 #define OC_PRESENCE_URI "/oc/presence"
49 //-----------------------------------------------------------------------------
51 //-----------------------------------------------------------------------------
54 * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
56 typedef struct OCDevAddr
58 uint32_t size; // length of the address stored in addr field.
59 uint8_t addr[DEV_ADDR_SIZE_MAX]; // device address.
63 * OC Virtual resources supported by every OC device.
67 OC_WELL_KNOWN_URI= 0, // "/oc/core"
68 OC_DEVICE_URI, // "/oc/core/d"
69 OC_RESOURCE_TYPES_URI, // "/oc/core/d/type"
71 OC_PRESENCE, // "/oc/presence"
73 OC_MAX_VIRTUAL_RESOURCES // Max items in the list
77 * Standard RESTful HTTP Methods.
82 OC_REST_GET = (1 << 0), // Read
83 OC_REST_PUT = (1 << 1), // Write
84 OC_REST_POST = (1 << 2), // Update
85 OC_REST_DELETE = (1 << 3), // Delete
86 // Register observe request for most up date notifications ONLY.
87 OC_REST_OBSERVE = (1 << 4),
88 // Register observe request for all notifications, including stale notifications.
89 OC_REST_OBSERVE_ALL = (1 << 5),
90 // Deregister observation, intended for internal use
91 OC_REST_CANCEL_OBSERVE = (1 << 6),
93 // Subscribe for all presence notifications of a particular resource.
94 OC_REST_PRESENCE = (1 << 7)
99 * Host Mode of Operation.
109 * Quality of Service.
116 OC_NA_QOS // No Quality is defined, let the stack decide
117 } OCQualityOfService;
120 * Resource Properties.
122 * ::OC_ACTIVE When this bit is set, the resource is initialized, otherwise the resource
123 * is 'inactive'. 'inactive' signifies that the resource has been marked for
124 * deletion or is already deleted.
125 * ::OC_DISCOVERABLE When this bit is set, the resource is allowed to be discovered by clients.
126 * ::OC_OBSERVABLE When this bit is set, the resource is allowed to be observed by clients.
127 * ::OC_SLOW When this bit is set, the resource has been marked as 'slow'. 'slow' signifies
128 * that responses from this resource can expect delays in processing its
129 * requests from clients.
130 * ::OC_SECURE When this bit is set, the resource is a secure resource.
134 OC_ACTIVE = (1 << 0),
135 OC_DISCOVERABLE = (1 << 1),
136 OC_OBSERVABLE = (1 << 2),
139 } OCResourceProperty;
142 * Transport Protocol IDs.
146 OC_INVALID_ID = (1 << 0),
147 OC_COAP_ID = (1 << 1)
148 } OCTransportProtocolID;
159 OC_ALL // Multicast message: send over all the interfaces.
160 } OCConnectivityType;
163 * Declares Stack Results & Errors.
167 /* Success status code - START HERE */
169 OC_STACK_RESOURCE_CREATED,
170 OC_STACK_RESOURCE_DELETED,
172 /* Success status code - END HERE */
173 /* Error status code - START HERE */
174 OC_STACK_INVALID_URI = 20,
175 OC_STACK_INVALID_QUERY,
177 OC_STACK_INVALID_PORT,
178 OC_STACK_INVALID_CALLBACK,
179 OC_STACK_INVALID_METHOD,
180 OC_STACK_INVALID_PARAM,
181 OC_STACK_INVALID_OBSERVE_PARAM,
185 OC_STACK_ADAPTER_NOT_ENABLED,
187 OC_STACK_NO_RESOURCE, /* resource not found */
188 OC_STACK_RESOURCE_ERROR, /* ex: not supported method or interface */
189 OC_STACK_SLOW_RESOURCE,
190 OC_STACK_DUPLICATE_REQUEST,
191 OC_STACK_NO_OBSERVERS, /* resource has no registered observers */
192 OC_STACK_OBSERVER_NOT_FOUND,
193 OC_STACK_VIRTUAL_DO_NOT_HANDLE,
194 OC_STACK_INVALID_OPTION,
195 OC_STACK_MALFORMED_RESPONSE, /* the remote reply contained malformed data */
196 OC_STACK_PERSISTENT_BUFFER_REQUIRED,
197 OC_STACK_INVALID_REQUEST_HANDLE,
198 OC_STACK_INVALID_DEVICE_INFO,
199 OC_STACK_INVALID_JSON,
200 /* NOTE: Insert all new error codes here!*/
202 OC_STACK_PRESENCE_STOPPED = 128,
203 OC_STACK_PRESENCE_TIMEOUT,
204 OC_STACK_PRESENCE_DO_NOT_HANDLE,
207 /* Error status code - END HERE */
211 * Handle to an @ref OCDoResource invocation.
213 typedef void * OCDoHandle;
216 * Handle to an OCResource object owned by the OCStack.
218 typedef void * OCResourceHandle;
220 typedef void * OCRequestHandle;
221 typedef void * OCResponseHandle;
224 * Unique identifier for each observation request. Used when observations are
225 * registered or deregistering. Used by entity handler to signal specific
226 * observers to be notified of resource changes.
227 * There can be maximum of 256 observations per server.
229 typedef uint8_t OCObservationId;
232 * Action associated with observation.
236 OC_OBSERVE_REGISTER = 0,
237 OC_OBSERVE_DEREGISTER = 1,
238 OC_OBSERVE_NO_OPTION = 2
243 // Action associated with observation request
244 OCObserveAction action;
245 // Identifier for observation being registered/deregistered
246 OCObservationId obsId;
250 * Possible returned values from entity handler.
256 OC_EH_RESOURCE_CREATED,
257 OC_EH_RESOURCE_DELETED,
260 OC_EH_RESOURCE_NOT_FOUND
261 } OCEntityHandlerResult;
264 * This structure will be used to define the vendor specific header options to be included
265 * in communication packets.
267 typedef struct OCHeaderOption
269 // The protocol ID this option applies to
270 OCTransportProtocolID protocolID;
271 // The header option ID which will be added to communication packets
274 uint16_t optionLength;
275 // pointer to its data
276 uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
280 * Incoming requests handled by the server. Requests are passed in as a parameter to the
281 * @ref OCEntityHandler callback API.
282 * @brief The @ref OCEntityHandler callback API must be implemented in the application in order
283 * to receive these requests.
287 // Associated resource
288 OCResourceHandle resource;
289 OCRequestHandle requestHandle;
290 // the REST method retrieved from received request PDU
292 // resource query send by client
294 // Information associated with observation - valid only when OCEntityHandler
295 // flag includes OC_OBSERVE_FLAG
296 OCObservationInfo obsInfo;
297 // An array of the received vendor specific header options
298 uint8_t numRcvdVendorSpecificHeaderOptions;
299 OCHeaderOption * rcvdVendorSpecificHeaderOptions;
300 // reqJSON is retrieved from the payload of the received request PDU
301 char * reqJSONPayload;
302 } OCEntityHandlerRequest;
305 * Response from queries to remote servers. Queries are made by calling the @ref OCDoResource API.
309 // Address of remote server
311 // Indicates adaptor type on which the response was received
312 OCConnectivityType connType;
313 // the is the result of our stack, OCStackResult should contain coap/other error codes;
314 OCStackResult result;
315 // If associated with observe, this will represent the sequence of notifications from server.
316 uint32_t sequenceNumber;
317 // resJSONPayload is retrieved from the payload of the received request PDU
318 const char * resJSONPayload;
319 // An array of the received vendor specific header options
320 uint8_t numRcvdVendorSpecificHeaderOptions;
321 OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
325 * This structure describes the device properties. All non-Null properties will be included
326 * in a device discovery request.
335 char *manufacturerName;
336 char *manufacturerUrl;
338 char *dateOfManufacture;
339 char *platformVersion;
340 char *firmwareVersion;
346 // Request handle is passed to server via the entity handler for each incoming request.
347 // Stack assigns when request is received, server sets to indicate what request response is for
348 OCRequestHandle requestHandle;
349 // New handle for tracking block (or slow) response. Stack assigns, server uses for subsequent calls
350 OCResponseHandle *responseHandle;
352 OCResourceHandle resourceHandle;
353 // Allow the entity handler to pass a result with the response
354 OCEntityHandlerResult ehResult;
355 // this is the pointer to server payload data to be transferred
357 // size of server payload data. I don't think we should rely on null terminated data for size
358 uint16_t payloadSize;
359 // An array of the vendor specific header options the entity handler wishes to use in response
360 uint8_t numSendVendorSpecificHeaderOptions;
361 OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
362 // URI of new resource that entity handler might create
363 char resourceUri[MAX_URI_LENGTH];
364 // Server sets to true for persistent response buffer, false for non-persistent response buffer
365 uint8_t persistentBufferFlag;
366 } OCEntityHandlerResponse;
370 OC_INIT_FLAG = (1 << 0),
371 OC_REQUEST_FLAG = (1 << 1),
372 OC_OBSERVE_FLAG = (1 << 2)
373 } OCEntityHandlerFlag; //entity_handler_flag_t ;
376 * Possible returned values from client application.
380 OC_STACK_DELETE_TRANSACTION = 0,//!< OC_STACK_DELETE_TRANSACTION
381 OC_STACK_KEEP_TRANSACTION //!< OC_STACK_KEEP_TRANSACTION
382 } OCStackApplicationResult;
384 //-----------------------------------------------------------------------------
385 // Callback function definitions
386 //-----------------------------------------------------------------------------
389 * Client applications implement this callback to consume responses received from Servers.
391 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
392 OCClientResponse * clientResponse);
395 * Client applications using a context pointer implement this callback to delete the
396 * context upon removal of the callback/context pointer from the internal callback-list.
398 typedef void (* OCClientContextDeleter)(void *context);
401 * This info is passed from application to OC Stack when initiating a request to Server.
406 OCClientResponseHandler cb;
407 OCClientContextDeleter cd;
411 * Application server implementations must implement this callback to consume requests OTA.
412 * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
414 typedef OCEntityHandlerResult (*OCEntityHandler)
415 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest);
418 * Device Entity handler need to use this call back instead of OCEntityHandler.
420 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
421 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri);
423 //-----------------------------------------------------------------------------
424 // Function prototypes
425 //-----------------------------------------------------------------------------
428 * Initialize the OC Stack. Must be called prior to starting the stack.
431 * IP Address of host device. Deprecated parameter.
433 * Port of host device. Deprecated parameter.
435 * Host device is client, server, or client-server.
437 * @return ::OC_STACK_OK on success, some other value upon failure.
439 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode);
442 * Stop the OC stack. Use for a controlled shutdown.
444 * Note: OCStop() performs operations similar to OCStopPresence(), as well as OCDeleteResource() on
445 * all resources this server is hosting. OCDeleteResource() performs operations similar to
446 * OCNotifyAllObservers() to notify all client observers that the respective resource is being
449 * @return ::OC_STACK_OK on success, some other value upon failure.
451 OCStackResult OCStop();
454 * Called in main loop of OC client or server. Allows low-level processing of
457 * @return ::OC_STACK_OK on success, some other value upon failure.
459 OCStackResult OCProcess();
462 * Discover or Perform requests on a specified resource (specified by that Resource's respective
465 * @param handle @ref OCDoHandle to refer to the request sent out on behalf of
466 * calling this API. This handle can be used to cancel this operation
467 * via the OCCancel API.
468 * Note: This reference is handled internally, and
469 * should not be free'd by the consumer. A NULL handle is permitted
470 * in the event where the caller has no use for the return value.
471 * @param method @ref OCMethod to perform on the resource.
472 * @param requiredUri URI of the resource to interact with.
473 * @param referenceUri URI of the reference resource.
474 * @param request JSON encoded request.
475 * @param conType @ref OCConnectivityType type of connectivity indicating the
476 * interface. Example: ::OC_WIFI, ::OC_ETHERNET, ::OC_ALL.
477 * @param qos Quality of service. Note that if this API is called on a uri with
478 * the well-known multicast IP address, the qos will be forced to
480 * since it is impractical to send other QOS levels on such addresses.
481 * @param cbData Asynchronous callback function that is invoked
482 * by the stack when discovery or resource interaction is complete.
483 * @param options The address of an array containing the vendor specific
484 * header options to be sent with the request.
485 * @param numOptions Number of header options to be included.
487 * Note: Presence subscription amendments (ie. adding additional resource type filters by calling
488 * this API again) require the use of the same base URI as the original request to successfully
489 * amend the presence filters.
491 * @return ::OC_STACK_OK on success, some other value upon failure.
493 OCStackResult OCDoResource(OCDoHandle *handle, OCMethod method, const char *requiredUri,
494 const char *referenceUri, const char *request, OCConnectivityType conType,
495 OCQualityOfService qos, OCCallbackData *cbData,
496 OCHeaderOption * options, uint8_t numOptions);
499 * Cancel a request associated with a specific @ref OCDoResource invocation.
501 * @param handle - Used to identify a specific OCDoResource invocation.
502 * @param qos - used to specify Quality of Service (read below for more info)
503 * @param options- used to specify vendor specific header options when sending
504 * explicit observe cancellation
505 * @param numOptions- Number of header options to be included
507 * @return ::OC_STACK_OK on success, some other value upon failure.
509 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
514 * When operating in @ref OCServer or @ref OCClientServer mode, this API will start sending out
515 * presence notifications to clients via multicast. Once this API has been called with a success,
516 * clients may query for this server's presence and this server's stack will respond via multicast.
518 * Server can call this function when it comes online for the first time, or when it comes back
519 * online from offline mode, or when it re enters network.
521 * @param ttl Time To Live in seconds.
522 * Note: If ttl is '0', then the default stack value will be used (60 Seconds).
524 * @return ::OC_STACK_OK on success, some other value upon failure.
526 OCStackResult OCStartPresence(const uint32_t ttl);
529 * When operating in @ref OCServer or @ref OCClientServer mode, this API will stop sending out
530 * presence notifications to clients via multicast. Once this API has been called with a success,
531 * this server's stack will not respond to clients querying for this server's presence.
533 * Server can call this function when it is terminating, going offline, or when going
536 * @return ::OC_STACK_OK on success, some other value upon failure.
539 OCStackResult OCStopPresence();
544 * Set default device entity handler.
546 * @param entityHandler Entity handler function that is called by ocstack to handle requests for
547 * any undefined resources or default actions.
548 * If NULL is passed it removes the device default entity handler.
550 * @return ::OC_STACK_OK on success, some other value upon failure.
552 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler);
555 * Set device information.
557 * @param deviceInfo - Structure passed by the server application containing
558 * the device information.
562 * OC_STACK_OK - no errors
563 * OC_STACK_INVALID_PARAM - invalid paramerter
564 * OC_STACK_ERROR - stack process error
566 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo);
571 * @param handle Pointer to handle to newly created resource. Set by ocstack and
572 * used to refer to resource.
573 * @param resourceTypeName Name of resource type. Example: "core.led".
574 * @param resourceInterfaceName Name of resource interface. Example: "core.rw".
575 * @param uri URI of the resource. Example: "/a/led".
576 * @param entityHandler Entity handler function that is called by ocstack to handle requests, etc.
577 * NULL for default entity handler.
578 * @param resourceProperties Properties supported by resource.
579 * Example: ::OC_DISCOVERABLE|::OC_OBSERVABLE.
581 * @return ::OC_STACK_OK on success, some other value upon failure.
583 OCStackResult OCCreateResource(OCResourceHandle *handle,
584 const char *resourceTypeName,
585 const char *resourceInterfaceName,
587 OCEntityHandler entityHandler,
588 uint8_t resourceProperties);
591 * Create a resource. with host ip address for remote resource.
593 * @param handle Pointer to handle to newly created resource. Set by ocstack.
594 * Used to refer to resource.
595 * @param resourceTypeName Name of resource type. Example: "core.led".
596 * @param resourceInterfaceName Name of resource interface. Example: "core.rw".
597 * @param host HOST address of the remote resource. Example: "coap://xxx.xxx.xxx.xxx:xxxxx".
598 * @param uri URI of the resource. Example: "/a/led".
599 * @param entityHandler Entity handler function that is called by ocstack to handle requests, etc.
600 * NULL for default entity handler.
601 * @param resourceProperties Properties supported by resource.
602 * Example: ::OC_DISCOVERABLE|::OC_OBSERVABLE
604 * @return ::OC_STACK_OK on success, some other value upon failure.
606 OCStackResult OCCreateResourceWithHost(OCResourceHandle *handle,
607 const char *resourceTypeName,
608 const char *resourceInterfaceName,
611 OCEntityHandler entityHandler,
612 uint8_t resourceProperties);
615 * Add a resource to a collection resource.
617 * @param collectionHandle Handle to the collection resource.
618 * @param resourceHandle Handle to resource to be added to the collection resource.
620 * @return ::OC_STACK_OK on success, some other value upon failure.
622 OCStackResult OCBindResource(OCResourceHandle collectionHandle, OCResourceHandle resourceHandle);
625 * Remove a resource from a collection resource.
627 * @param collectionHandle Handle to the collection resource.
628 * @param resourceHandle Handle to resource to be removed from the collection resource.
630 * @return ::OC_STACK_OK on success, some other value upon failure.
632 OCStackResult OCUnBindResource(OCResourceHandle collectionHandle, OCResourceHandle resourceHandle);
635 * Bind a resourcetype to a resource.
637 * @param handle Handle to the resource.
638 * @param resourceTypeName Name of resource type. Example: "core.led".
640 * @return ::OC_STACK_OK on success, some other value upon failure.
642 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
643 const char *resourceTypeName);
645 * Bind a resource interface to a resource.
647 * @param handle Handle to the resource.
648 * @param resourceInterfaceName Name of resource interface. Example: "core.rw".
650 * @return ::OC_STACK_OK on success, some other value upon failure.
652 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
653 const char *resourceInterfaceName);
656 * Bind an entity handler to the resource.
658 * @param handle Handle to the resource that the contained resource is to be bound.
659 * @param entityHandler Entity handler function that is called by ocstack to handle requests, etc.
660 * @return ::OC_STACK_OK on success, some other value upon failure.
662 OCStackResult OCBindResourceHandler(OCResourceHandle handle, OCEntityHandler entityHandler);
665 * Get the number of resources that have been created in the stack.
667 * @param numResources Pointer to count variable.
669 * @return ::OC_STACK_OK on success, some other value upon failure.
671 OCStackResult OCGetNumberOfResources(uint8_t *numResources);
674 * Get a resource handle by index.
676 * @param index Index of resource, 0 to Count - 1.
678 * @return Found resource handle or NULL if not found.
680 OCResourceHandle OCGetResourceHandle(uint8_t index);
683 * Delete resource specified by handle. Deletes resource and all resourcetype and resourceinterface
686 * Note: OCDeleteResource() performs operations similar to OCNotifyAllObservers() to notify all
687 * client observers that "this" resource is being deleted.
689 * @param handle Handle of resource to be deleted.
691 * @return ::OC_STACK_OK on success, some other value upon failure.
693 OCStackResult OCDeleteResource(OCResourceHandle handle);
696 * Get the URI of the resource specified by handle.
698 * @param handle Handle of resource.
699 * @return URI string if resource found or NULL if not found.
701 const char *OCGetResourceUri(OCResourceHandle handle);
704 * Get the properties of the resource specified by handle.
705 * NOTE: that after a resource is created, the OC_ACTIVE property is set
706 * for the resource by the stack.
708 * @param handle Handle of resource.
709 * @return OCResourceProperty Bitmask or -1 if resource is not found.
711 OCResourceProperty OCGetResourceProperties(OCResourceHandle handle);
714 * Get the number of resource types of the resource.
716 * @param handle Handle of resource.
717 * @param numResourceTypes Pointer to count variable.
719 * @return ::OC_STACK_OK on success, some other value upon failure.
721 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle, uint8_t *numResourceTypes);
724 * Get name of resource type of the resource.
726 * @param handle Handle of resource.
727 * @param index Index of resource, 0 to Count - 1.
729 * @return Resource type name if resource found or NULL if resource not found.
731 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index);
734 * Get the number of resource interfaces of the resource.
736 * @param handle Handle of resource.
737 * @param numResourceInterfaces Pointer to count variable.
739 * @return ::OC_STACK_OK on success, some other value upon failure.
741 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
742 uint8_t *numResourceInterfaces);
745 * Get name of resource interface of the resource.
747 * @param handle Handle of resource.
748 * @param index Index of resource, 0 to Count - 1.
750 * @return Resource interface name if resource found or NULL if resource not found.
752 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index);
755 * Get methods of resource interface of the resource.
757 * @param handle Handle of resource.
758 * @param index Index of resource, 0 to Count - 1.
760 * @return Allowed methods if resource found or NULL if resource not found.
762 uint8_t OCGetResourceInterfaceAllowedMethods(OCResourceHandle handle, uint8_t index);
765 * Get resource handle from the collection resource by index.
767 * @param collectionHandle Handle of collection resource.
768 * @param index Index of contained resource, 0 to Count - 1.
770 * @return Handle to contained resource if resource found or NULL if resource not found.
772 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
776 * Get the entity handler for a resource.
778 * @param handle Handle of resource.
780 * @return Entity handler if resource found or NULL resource not found.
782 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle);
785 * Notify all registered observers that the resource representation has
786 * changed. If observation includes a query the client is notified only
787 * if the query is valid after the resource representation has changed.
789 * @param handle Handle of resource.
790 * @param qos Desired quality of service for the observation notifications.
792 * @return ::OC_STACK_OK on success, some other value upon failure.
794 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos);
797 * Notify specific observers with updated value of representation.
798 * Before this API is invoked by entity handler it has finished processing
799 * queries for the associated observers.
801 * @param handle Handle of resource.
802 * @param obsIdList List of observation ids that need to be notified.
803 * @param numberOfIds Number of observation ids included in obsIdList.
804 * @param notificationJSONPayload JSON encoded payload to send in notification.
805 * @param qos Desired quality of service of the observation notifications.
806 * NOTE: The memory for obsIdList and notificationJSONPayload is managed by the
807 * entity invoking the API. The maximum size of the notification is 1015 bytes
808 * for non-Arduino platforms. For Arduino the maximum size is 247 bytes.
810 * @return ::OC_STACK_OK on success, some other value upon failure.
813 OCNotifyListOfObservers (OCResourceHandle handle,
814 OCObservationId *obsIdList,
816 const char *notificationJSONPayload,
817 OCQualityOfService qos);
821 * Send a response to a request.
822 * The response can be a normal, slow, or block (i.e. a response that
823 * is too large to be sent in a single PDU and must span multiple transmissions).
825 * @param response Pointer to structure that contains response parameters.
827 * @return ::OC_STACK_OK on success, some other value upon failure.
829 OCStackResult OCDoResponse(OCEntityHandlerResponse *response);
832 * Cancel a response. Applies to a block response.
834 * @param responseHandle Response handle set by stack in OCServerResponse after
835 * OCDoResponse is called.
837 * @return ::OC_STACK_OK on success, some other value upon failure.
839 OCStackResult OCCancelResponse(OCResponseHandle responseHandle);
844 * This method is used to retrieved the IPv4 address from OCDev address
847 * @param ipAddr OCDevAddr address.
848 * @param a first byte of IPv4 address.
849 * @param b second byte of IPv4 address.
850 * @param c third byte of IPv4 address.
851 * @param d fourth byte of IPv4 address.
852 * @return ::OC_STACK_OK on success, some other value upon failure.
854 int32_t OCDevAddrToIPv4Addr(OCDevAddr *ipAddr, uint8_t *a, uint8_t *b,
855 uint8_t *c, uint8_t *d );
858 * This method is used to retrieve the port number from OCDev address
861 * @param ipAddr OCDevAddr address.
862 * @param port Port number.
863 * @return ::OC_STACK_OK on success, some other value upon failure.
865 int32_t OCDevAddrToPort(OCDevAddr *ipAddr, uint16_t *port);
869 #endif // __cplusplus
871 #endif /* OCSTACK_H_ */