resource/csdk/stack/include/ocstack.h

   1 //******************************************************************
   2 //
   3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   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
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  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.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 #ifndef OCSTACK_H_
  22 #define OCSTACK_H_
  23
  24 #include <stdint.h>
  25 #include "ocstackconfig.h"
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif // __cplusplus
  30 #define WITH_PRESENCE
  31 //-----------------------------------------------------------------------------
  32 // Defines
  33 //-----------------------------------------------------------------------------
  34
  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.
  37
  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
  43
  44 #ifdef WITH_PRESENCE
  45 #define OC_DEFAULT_PRESENCE_TTL (60)
  46 #define OC_PRESENCE_URI                      "/oc/presence"
  47 #endif
  48
  49 //-----------------------------------------------------------------------------
  50 // Typedefs
  51 //-----------------------------------------------------------------------------
  52
  53 /**
  54  * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
  55  */
  56 typedef struct OCDevAddr
  57 {
  58     uint32_t     size;                    // length of the address stored in addr field.
  59     uint8_t      addr[DEV_ADDR_SIZE_MAX]; // device address.
  60 } OCDevAddr;
  61
  62 /**
  63  * OC Virtual resources supported by every OC device.
  64  */
  65 typedef enum
  66 {
  67     OC_WELL_KNOWN_URI= 0,       // "/oc/core"
  68     OC_DEVICE_URI,              // "/oc/core/d"
  69     OC_RESOURCE_TYPES_URI,      // "/oc/core/d/type"
  70     #ifdef WITH_PRESENCE
  71     OC_PRESENCE,                // "/oc/presence"
  72     #endif
  73     OC_MAX_VIRTUAL_RESOURCES    // Max items in the list
  74 } OCVirtualResources;
  75
  76 /**
  77  * Standard RESTful HTTP Methods.
  78  */
  79 typedef enum
  80 {
  81     OC_REST_NOMETHOD    = 0,
  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),
  92     #ifdef WITH_PRESENCE
  93     // Subscribe for all presence notifications of a particular resource.
  94     OC_REST_PRESENCE    = (1 << 7)
  95     #endif
  96 } OCMethod;
  97
  98 /**
  99  * Host Mode of Operation.
 100  */
 101 typedef enum
 102 {
 103     OC_CLIENT = 0,
 104     OC_SERVER,
 105     OC_CLIENT_SERVER
 106 } OCMode;
 107
 108 /**
 109  * Quality of Service.
 110  */
 111 typedef enum
 112 {
 113     OC_LOW_QOS = 0,
 114     OC_MEDIUM_QOS,
 115     OC_HIGH_QOS,
 116     OC_NA_QOS // No Quality is defined, let the stack decide
 117 } OCQualityOfService;
 118
 119 /**
 120  * Resource Properties.
 121  *
 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.
 131  */
 132 typedef enum
 133 {
 134     OC_ACTIVE       = (1 << 0),
 135     OC_DISCOVERABLE = (1 << 1),
 136     OC_OBSERVABLE   = (1 << 2),
 137     OC_SLOW         = (1 << 3),
 138     OC_SECURE       = (1 << 4)
 139 } OCResourceProperty;
 140
 141 /**
 142  * Transport Protocol IDs.
 143  */
 144 typedef enum
 145 {
 146     OC_INVALID_ID   = (1 << 0),
 147     OC_COAP_ID      = (1 << 1)
 148 } OCTransportProtocolID;
 149
 150 /**
 151  * Adaptor types.
 152  */
 153 typedef enum
 154 {
 155     OC_ETHERNET = 0,
 156     OC_WIFI,
 157     OC_EDR,
 158     OC_LE,
 159     OC_ALL // Multicast message: send over all the interfaces.
 160 } OCConnectivityType;
 161
 162 /**
 163  * Declares Stack Results & Errors.
 164  */
 165 typedef enum
 166 {
 167     /* Success status code - START HERE */
 168     OC_STACK_OK = 0,
 169     OC_STACK_RESOURCE_CREATED,
 170     OC_STACK_RESOURCE_DELETED,
 171     OC_STACK_CONTINUE,
 172     /* Success status code - END HERE */
 173     /* Error status code - START HERE */
 174     OC_STACK_INVALID_URI = 20,
 175     OC_STACK_INVALID_QUERY,
 176     OC_STACK_INVALID_IP,
 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,
 182     OC_STACK_NO_MEMORY,
 183     OC_STACK_COMM_ERROR,
 184     OC_STACK_TIMEOUT,
 185     OC_STACK_ADAPTER_NOT_ENABLED,
 186     OC_STACK_NOTIMPL,
 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_NO_OBSERVERS,              /* resource has no registered observers */
 191     OC_STACK_OBSERVER_NOT_FOUND,
 192     OC_STACK_VIRTUAL_DO_NOT_HANDLE,
 193     OC_STACK_INVALID_OPTION,
 194     OC_STACK_MALFORMED_RESPONSE,        /* the remote reply contained malformed data */
 195     OC_STACK_PERSISTENT_BUFFER_REQUIRED,
 196     OC_STACK_INVALID_REQUEST_HANDLE,
 197     OC_STACK_INVALID_DEVICE_INFO,
 198     OC_STACK_INVALID_JSON,
 199     /* NOTE: Insert all new error codes here!*/
 200     #ifdef WITH_PRESENCE
 201     OC_STACK_PRESENCE_STOPPED = 128,
 202     OC_STACK_PRESENCE_TIMEOUT,
 203     OC_STACK_PRESENCE_DO_NOT_HANDLE,
 204     #endif
 205     OC_STACK_ERROR = 255
 206     /* Error status code - END HERE */
 207 } OCStackResult;
 208
 209 /**
 210  * Handle to an @ref OCDoResource invocation.
 211  */
 212 typedef void * OCDoHandle;
 213
 214 /**
 215  * Handle to an OCResource object owned by the OCStack.
 216  */
 217 typedef void * OCResourceHandle;
 218
 219 typedef void * OCRequestHandle;
 220 typedef void * OCResponseHandle;
 221
 222 /**
 223  * Unique identifier for each observation request. Used when observations are
 224  * registered or deregistering. Used by entity handler to signal specific
 225  * observers to be notified of resource changes.
 226  * There can be maximum of 256 observations per server.
 227  */
 228 typedef uint8_t OCObservationId;
 229
 230 /**
 231  * Action associated with observation.
 232  */
 233 typedef enum
 234 {
 235     OC_OBSERVE_REGISTER = 0,
 236     OC_OBSERVE_DEREGISTER = 1,
 237     OC_OBSERVE_NO_OPTION = 2
 238 } OCObserveAction;
 239
 240 typedef struct
 241 {
 242     // Action associated with observation request
 243     OCObserveAction action;
 244     // Identifier for observation being registered/deregistered
 245     OCObservationId obsId;
 246 } OCObservationInfo;
 247
 248 /**
 249  * Possible returned values from entity handler.
 250  */
 251 typedef enum
 252 {
 253     OC_EH_OK = 0,
 254     OC_EH_ERROR,
 255     OC_EH_RESOURCE_CREATED,
 256     OC_EH_RESOURCE_DELETED,
 257     OC_EH_SLOW,
 258     OC_EH_FORBIDDEN,
 259     OC_EH_RESOURCE_NOT_FOUND
 260 } OCEntityHandlerResult;
 261
 262 /**
 263  * This structure will be used to define the vendor specific header options to be included
 264  * in communication packets.
 265  */
 266 typedef struct OCHeaderOption
 267 {
 268     // The protocol ID this option applies to
 269     OCTransportProtocolID protocolID;
 270     // The header option ID which will be added to communication packets
 271     uint16_t optionID;
 272     // its length   191
 273     uint16_t optionLength;
 274     // pointer to its data
 275     uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
 276 } OCHeaderOption;
 277
 278 /**
 279  * Incoming requests handled by the server. Requests are passed in as a parameter to the
 280  * @ref OCEntityHandler callback API.
 281  * @brief The @ref OCEntityHandler callback API must be implemented in the application in order
 282  * to receive these requests.
 283  */
 284 typedef struct
 285 {
 286     // Associated resource
 287     OCResourceHandle resource;
 288     OCRequestHandle requestHandle;
 289     // the REST method retrieved from received request PDU
 290     OCMethod method;
 291     // resource query send by client
 292     char * query;
 293     // Information associated with observation - valid only when OCEntityHandler
 294     // flag includes OC_OBSERVE_FLAG
 295     OCObservationInfo obsInfo;
 296     // An array of the received vendor specific header options
 297     uint8_t numRcvdVendorSpecificHeaderOptions;
 298     OCHeaderOption * rcvdVendorSpecificHeaderOptions;
 299     // reqJSON is retrieved from the payload of the received request PDU
 300     char * reqJSONPayload;
 301 } OCEntityHandlerRequest;
 302
 303 /**
 304  * Response from queries to remote servers. Queries are made by calling the @ref OCDoResource API.
 305  */
 306 typedef struct
 307 {
 308     // Address of remote server
 309     OCDevAddr * addr;
 310     // Indicates adaptor type on which the response was received
 311     OCConnectivityType connType;
 312     // the is the result of our stack, OCStackResult should contain coap/other error codes;
 313     OCStackResult result;
 314     // If associated with observe, this will represent the sequence of notifications from server.
 315     uint32_t sequenceNumber;
 316     // resJSONPayload is retrieved from the payload of the received request PDU
 317     const char * resJSONPayload;
 318     // An array of the received vendor specific header options
 319     uint8_t numRcvdVendorSpecificHeaderOptions;
 320     OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
 321 } OCClientResponse;
 322
 323 /**
 324  * This structure describes the device properties. All non-Null properties will be included
 325  * in a device discovery request.
 326  */
 327 typedef struct
 328 {
 329     char *deviceName;
 330     char *hostName;
 331     char *deviceUUID;
 332     char *contentType;
 333     char *version;
 334     char *manufacturerName;
 335     char *manufacturerUrl;
 336     char *modelNumber;
 337     char *dateOfManufacture;
 338     char *platformVersion;
 339     char *firmwareVersion;
 340     char *supportUrl;
 341 } OCDeviceInfo;
 342
 343 typedef struct
 344 {
 345     // Request handle is passed to server via the entity handler for each incoming request.
 346     // Stack assigns when request is received, server sets to indicate what request response is for
 347     OCRequestHandle requestHandle;
 348     // New handle for tracking block (or slow) response.  Stack assigns, server uses for subsequent calls
 349     OCResponseHandle  *responseHandle;
 350     // Resource handle
 351     OCResourceHandle resourceHandle;
 352     // Allow the entity handler to pass a result with the response
 353     OCEntityHandlerResult  ehResult;
 354     // this is the pointer to server payload data to be transferred
 355     char *payload;
 356     // size of server payload data.  I don't think we should rely on null terminated data for size
 357     uint16_t payloadSize;
 358     // An array of the vendor specific header options the entity handler wishes to use in response
 359     uint8_t numSendVendorSpecificHeaderOptions;
 360     OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
 361     // URI of new resource that entity handler might create
 362     char resourceUri[MAX_URI_LENGTH];
 363     // Server sets to true for persistent response buffer, false for non-persistent response buffer
 364     uint8_t persistentBufferFlag;
 365 } OCEntityHandlerResponse;
 366
 367 typedef enum
 368 {
 369     OC_INIT_FLAG    = (1 << 0),
 370     OC_REQUEST_FLAG = (1 << 1),
 371     OC_OBSERVE_FLAG = (1 << 2)
 372 } OCEntityHandlerFlag; //entity_handler_flag_t ;
 373
 374 /**
 375  * Possible returned values from client application.
 376  */
 377 typedef enum
 378 {
 379     OC_STACK_DELETE_TRANSACTION = 0,//!< OC_STACK_DELETE_TRANSACTION
 380     OC_STACK_KEEP_TRANSACTION       //!< OC_STACK_KEEP_TRANSACTION
 381 } OCStackApplicationResult;
 382
 383 //-----------------------------------------------------------------------------
 384 // Callback function definitions
 385 //-----------------------------------------------------------------------------
 386
 387 /**
 388  * Client applications implement this callback to consume responses received from Servers.
 389  */
 390 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
 391     OCClientResponse * clientResponse);
 392
 393 /**
 394  * Client applications using a context pointer implement this callback to delete the
 395  * context upon removal of the callback/context pointer from the internal callback-list.
 396  */
 397 typedef void (* OCClientContextDeleter)(void *context);
 398
 399 /*
 400  * This info is passed from application to OC Stack when initiating a request to Server.
 401  */
 402 typedef struct
 403 {
 404     void *context;
 405     OCClientResponseHandler cb;
 406     OCClientContextDeleter cd;
 407 } OCCallbackData;
 408
 409 /**
 410  * Application server implementations must implement this callback to consume requests OTA.
 411  * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
 412  */
 413 typedef OCEntityHandlerResult (*OCEntityHandler)
 414 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest);
 415
 416 /**
 417  * Device Entity handler need to use this call back instead of OCEntityHandler.
 418  */
 419 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
 420 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri);
 421
 422 //-----------------------------------------------------------------------------
 423 // Function prototypes
 424 //-----------------------------------------------------------------------------
 425
 426 /**
 427  * Initialize the OC Stack.  Must be called prior to starting the stack.
 428  *
 429  * @param ipAddr
 430  *     IP Address of host device. Deprecated parameter.
 431  * @param port
 432  *     Port of host device. Deprecated parameter.
 433  * @param mode
 434  *     Host device is client, server, or client-server.
 435  *
 436  * @return ::OC_STACK_OK on success, some other value upon failure.
 437  */
 438 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode);
 439
 440 /**
 441  * Stop the OC stack.  Use for a controlled shutdown.
 442  *
 443  * Note: OCStop() performs operations similar to OCStopPresence(), as well as OCDeleteResource() on
 444  * all resources this server is hosting. OCDeleteResource() performs operations similar to
 445  * OCNotifyAllObservers() to notify all client observers that the respective resource is being
 446  * deleted.
 447  *
 448  * @return ::OC_STACK_OK on success, some other value upon failure.
 449  */
 450 OCStackResult OCStop();
 451
 452 /**
 453  * Called in main loop of OC client or server.  Allows low-level processing of
 454  * stack services.
 455  *
 456  * @return ::OC_STACK_OK on success, some other value upon failure.
 457  */
 458 OCStackResult OCProcess();
 459
 460 /**
 461  * Discover or Perform requests on a specified resource (specified by that Resource's respective
 462  * URI).
 463  *
 464  * @param handle             @ref OCDoHandle to refer to the request sent out on behalf of
 465  *                           calling this API. This handle can be used to cancel this operation
 466  *                           via the OCCancel API.
 467  *                           Note: This reference is handled internally, and
 468  *                           should not be free'd by the consumer.  A NULL handle is permitted
 469  *                           in the event where the caller has no use for the return value.
 470  * @param method             @ref OCMethod to perform on the resource.
 471  * @param requiredUri        URI of the resource to interact with.
 472  * @param referenceUri       URI of the reference resource.
 473  * @param request            JSON encoded request.
 474  * @param conType            @ref OCConnectivityType type of connectivity indicating the
 475  *                           interface. Example: ::OC_WIFI, ::OC_ETHERNET, ::OC_ALL.
 476  * @param qos                Quality of service. Note that if this API is called on a uri with
 477  *                           the well-known multicast IP address, the qos will be forced to
 478  *                           ::OC_LOW_QOS
 479  *                           since it is impractical to send other QOS levels on such addresses.
 480  * @param cbData             Asynchronous callback function that is invoked
 481  *                           by the stack when discovery or resource interaction is complete.
 482  * @param options            The address of an array containing the vendor specific
 483  *                           header options to be sent with the request.
 484  * @param numOptions         Number of header options to be included.
 485  *
 486  * Note: Presence subscription amendments (ie. adding additional resource type filters by calling
 487  * this API again) require the use of the same base URI as the original request to successfully
 488  * amend the presence filters.
 489  *
 490  * @return ::OC_STACK_OK on success, some other value upon failure.
 491  */
 492 OCStackResult OCDoResource(OCDoHandle *handle, OCMethod method, const char *requiredUri,
 493             const char *referenceUri, const char *request, OCConnectivityType conType,
 494             OCQualityOfService qos, OCCallbackData *cbData,
 495             OCHeaderOption * options, uint8_t numOptions);
 496
 497 /**
 498  * Cancel a request associated with a specific @ref OCDoResource invocation.
 499  *
 500  * @param handle - Used to identify a specific OCDoResource invocation.
 501  * @param qos    - used to specify Quality of Service (read below for more info)
 502  * @param options- used to specify vendor specific header options when sending
 503  *                 explicit observe cancellation
 504  * @param numOptions- Number of header options to be included
 505  *
 506  * @return ::OC_STACK_OK on success, some other value upon failure.
 507  */
 508 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
 509         uint8_t numOptions);
 510
 511 #ifdef WITH_PRESENCE
 512 /**
 513  * When operating in @ref OCServer or @ref OCClientServer mode, this API will start sending out
 514  * presence notifications to clients via multicast. Once this API has been called with a success,
 515  * clients may query for this server's presence and this server's stack will respond via multicast.
 516  *
 517  * Server can call this function when it comes online for the first time, or when it comes back
 518  * online from offline mode, or when it re enters network.
 519  *
 520  * @param ttl Time To Live in seconds.
 521  * Note: If ttl is '0', then the default stack value will be used (60 Seconds).
 522  *
 523  * @return ::OC_STACK_OK on success, some other value upon failure.
 524  */
 525 OCStackResult OCStartPresence(const uint32_t ttl);
 526
 527 /**
 528  * When operating in @ref OCServer or @ref OCClientServer mode, this API will stop sending out
 529  * presence notifications to clients via multicast. Once this API has been called with a success,
 530  * this server's stack will not respond to clients querying for this server's presence.
 531  *
 532  * Server can call this function when it is terminating, going offline, or when going
 533  * away from network.
 534  *
 535  * @return ::OC_STACK_OK on success, some other value upon failure.
 536  */
 537
 538 OCStackResult OCStopPresence();
 539 #endif
 540
 541
 542 /**
 543  * Set default device entity handler.
 544  *
 545  * @param entityHandler Entity handler function that is called by ocstack to handle requests for
 546  *                      any undefined resources or default actions.
 547  *                      If NULL is passed it removes the device default entity handler.
 548  *
 549  * @return ::OC_STACK_OK on success, some other value upon failure.
 550  */
 551 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler);
 552
 553 /**
 554  * Set device information.
 555  *
 556  * @param deviceInfo Structure passed by the server application containing
 557  *                   the device information.
 558  *
 559  * @return ::OC_STACK_OK on success, some other value upon failure.
 560  */
 561 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo);
 562
 563 /**
 564  * Create a resource.
 565  *
 566  * @param handle Pointer to handle to newly created resource.  Set by ocstack and
 567  *               used to refer to resource.
 568  * @param resourceTypeName Name of resource type.  Example: "core.led".
 569  * @param resourceInterfaceName Name of resource interface.  Example: "core.rw".
 570  * @param uri URI of the resource.  Example:  "/a/led".
 571  * @param entityHandler Entity handler function that is called by ocstack to handle requests, etc.
 572  *                      NULL for default entity handler.
 573  * @param resourceProperties Properties supported by resource.
 574  *                           Example: ::OC_DISCOVERABLE|::OC_OBSERVABLE.
 575  *
 576  * @return ::OC_STACK_OK on success, some other value upon failure.
 577  */
 578 OCStackResult OCCreateResource(OCResourceHandle *handle,
 579                                const char *resourceTypeName,
 580                                const char *resourceInterfaceName,
 581                                const char *uri,
 582                                OCEntityHandler entityHandler,
 583                                uint8_t resourceProperties);
 584
 585 /**
 586  * Create a resource. with host ip address for remote resource.
 587  *
 588  * @param handle Pointer to handle to newly created resource.  Set by ocstack.
 589  *               Used to refer to resource.
 590  * @param resourceTypeName Name of resource type.  Example: "core.led".
 591  * @param resourceInterfaceName Name of resource interface.  Example: "core.rw".
 592  * @param host HOST address of the remote resource.  Example:  "coap://xxx.xxx.xxx.xxx:xxxxx".
 593  * @param uri URI of the resource.  Example:  "/a/led".
 594  * @param entityHandler Entity handler function that is called by ocstack to handle requests, etc.
 595  *                      NULL for default entity handler.
 596  * @param resourceProperties Properties supported by resource.
 597  *                           Example: ::OC_DISCOVERABLE|::OC_OBSERVABLE
 598  *
 599  * @return ::OC_STACK_OK on success, some other value upon failure.
 600  */
 601 OCStackResult OCCreateResourceWithHost(OCResourceHandle *handle,
 602                                const char *resourceTypeName,
 603                                const char *resourceInterfaceName,
 604                                const char *host,
 605                                const char *uri,
 606                                OCEntityHandler entityHandler,
 607                                uint8_t resourceProperties);
 608
 609 /**
 610  * Add a resource to a collection resource.
 611  *
 612  * @param collectionHandle Handle to the collection resource.
 613  * @param resourceHandle Handle to resource to be added to the collection resource.
 614  *
 615  * @return ::OC_STACK_OK on success, some other value upon failure.
 616  */
 617 OCStackResult OCBindResource(OCResourceHandle collectionHandle, OCResourceHandle resourceHandle);
 618
 619 /**
 620  * Remove a resource from a collection resource.
 621  *
 622  * @param collectionHandle Handle to the collection resource.
 623  * @param resourceHandle Handle to resource to be removed from the collection resource.
 624  *
 625  * @return ::OC_STACK_OK on success, some other value upon failure.
 626  */
 627 OCStackResult OCUnBindResource(OCResourceHandle collectionHandle, OCResourceHandle resourceHandle);
 628
 629 /**
 630  * Bind a resourcetype to a resource.
 631  *
 632  * @param handle Handle to the resource.
 633  * @param resourceTypeName Name of resource type.  Example: "core.led".
 634  *
 635  * @return ::OC_STACK_OK on success, some other value upon failure.
 636  */
 637 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
 638                                            const char *resourceTypeName);
 639 /**
 640  * Bind a resource interface to a resource.
 641  *
 642  * @param handle Handle to the resource.
 643  * @param resourceInterfaceName Name of resource interface.  Example: "core.rw".
 644  *
 645  * @return ::OC_STACK_OK on success, some other value upon failure.
 646  */
 647 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
 648                                                 const char *resourceInterfaceName);
 649
 650 /**
 651  * Bind an entity handler to the resource.
 652  *
 653  * @param handle Handle to the resource that the contained resource is to be bound.
 654  * @param entityHandler Entity handler function that is called by ocstack to handle requests, etc.
 655  * @return ::OC_STACK_OK on success, some other value upon failure.
 656  */
 657 OCStackResult OCBindResourceHandler(OCResourceHandle handle, OCEntityHandler entityHandler);
 658
 659 /**
 660  * Get the number of resources that have been created in the stack.
 661  *
 662  * @param numResources Pointer to count variable.
 663  *
 664  * @return ::OC_STACK_OK on success, some other value upon failure.
 665  */
 666 OCStackResult OCGetNumberOfResources(uint8_t *numResources);
 667
 668 /**
 669  * Get a resource handle by index.
 670  *
 671  * @param index Index of resource, 0 to Count - 1.
 672  *
 673  * @return Found resource handle or NULL if not found.
 674  */
 675 OCResourceHandle OCGetResourceHandle(uint8_t index);
 676
 677 /**
 678  * Delete resource specified by handle.  Deletes resource and all resourcetype and resourceinterface
 679  * linked lists.
 680  *
 681  * Note: OCDeleteResource() performs operations similar to OCNotifyAllObservers() to notify all
 682  * client observers that "this" resource is being deleted.
 683  *
 684  * @param handle Handle of resource to be deleted.
 685  *
 686  * @return ::OC_STACK_OK on success, some other value upon failure.
 687  */
 688 OCStackResult OCDeleteResource(OCResourceHandle handle);
 689
 690 /**
 691  * Get the URI of the resource specified by handle.
 692  *
 693  * @param handle Handle of resource.
 694  * @return URI string if resource found or NULL if not found.
 695  */
 696 const char *OCGetResourceUri(OCResourceHandle handle);
 697
 698 /**
 699  * Get the properties of the resource specified by handle.
 700  * NOTE: that after a resource is created, the OC_ACTIVE property is set
 701  * for the resource by the stack.
 702  *
 703  * @param handle Handle of resource.
 704  * @return OCResourceProperty Bitmask or -1 if resource is not found.
 705  */
 706 OCResourceProperty OCGetResourceProperties(OCResourceHandle handle);
 707
 708 /**
 709  * Get the number of resource types of the resource.
 710  *
 711  * @param handle Handle of resource.
 712  * @param numResourceTypes Pointer to count variable.
 713  *
 714  * @return ::OC_STACK_OK on success, some other value upon failure.
 715  */
 716 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle, uint8_t *numResourceTypes);
 717
 718 /**
 719  * Get name of resource type of the resource.
 720  *
 721  * @param handle Handle of resource.
 722  * @param index Index of resource, 0 to Count - 1.
 723  *
 724  * @return Resource type name if resource found or NULL if resource not found.
 725  */
 726 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index);
 727
 728 /**
 729  * Get the number of resource interfaces of the resource.
 730  *
 731  * @param handle Handle of resource.
 732  * @param numResourceInterfaces Pointer to count variable.
 733  *
 734  * @return ::OC_STACK_OK on success, some other value upon failure.
 735  */
 736 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
 737         uint8_t *numResourceInterfaces);
 738
 739 /**
 740  * Get name of resource interface of the resource.
 741  *
 742  * @param handle Handle of resource.
 743  * @param index Index of resource, 0 to Count - 1.
 744  *
 745  * @return Resource interface name if resource found or NULL if resource not found.
 746  */
 747 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index);
 748
 749 /**
 750  * Get methods of resource interface of the resource.
 751  *
 752  * @param handle Handle of resource.
 753  * @param index Index of resource, 0 to Count - 1.
 754  *
 755  * @return Allowed methods if resource found or NULL if resource not found.
 756  */
 757 uint8_t OCGetResourceInterfaceAllowedMethods(OCResourceHandle handle, uint8_t index);
 758
 759 /**
 760  * Get resource handle from the collection resource by index.
 761  *
 762  * @param collectionHandle Handle of collection resource.
 763  * @param index Index of contained resource, 0 to Count - 1.
 764  *
 765  * @return Handle to contained resource if resource found or NULL if resource not found.
 766  */
 767 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
 768         uint8_t index);
 769
 770 /**
 771  * Get the entity handler for a resource.
 772  *
 773  * @param handle Handle of resource.
 774  *
 775  * @return Entity handler if resource found or NULL resource not found.
 776  */
 777 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle);
 778
 779 /**
 780  * Notify all registered observers that the resource representation has
 781  * changed. If observation includes a query the client is notified only
 782  * if the query is valid after the resource representation has changed.
 783  *
 784  * @param handle Handle of resource.
 785  * @param qos    Desired quality of service for the observation notifications.
 786  *
 787  * @return ::OC_STACK_OK on success, some other value upon failure.
 788  */
 789 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos);
 790
 791 /**
 792  * Notify specific observers with updated value of representation.
 793  * Before this API is invoked by entity handler it has finished processing
 794  * queries for the associated observers.
 795  *
 796  * @param handle Handle of resource.
 797  * @param obsIdList List of observation ids that need to be notified.
 798  * @param numberOfIds Number of observation ids included in obsIdList.
 799  * @param notificationJSONPayload JSON encoded payload to send in notification.
 800  * @param qos Desired quality of service of the observation notifications.
 801  * NOTE: The memory for obsIdList and notificationJSONPayload is managed by the
 802  * entity invoking the API. The maximum size of the notification is 1015 bytes
 803  * for non-Arduino platforms. For Arduino the maximum size is 247 bytes.
 804  *
 805  * @return ::OC_STACK_OK on success, some other value upon failure.
 806  */
 807 OCStackResult
 808 OCNotifyListOfObservers (OCResourceHandle handle,
 809                             OCObservationId  *obsIdList,
 810                             uint8_t          numberOfIds,
 811                             const char    *notificationJSONPayload,
 812                             OCQualityOfService qos);
 813
 814
 815 /**
 816  * Send a response to a request.
 817  * The response can be a normal, slow, or block (i.e. a response that
 818  * is too large to be sent in a single PDU and must span multiple transmissions).
 819  *
 820  * @param response Pointer to structure that contains response parameters.
 821  *
 822  * @return ::OC_STACK_OK on success, some other value upon failure.
 823  */
 824 OCStackResult OCDoResponse(OCEntityHandlerResponse *response);
 825
 826 /**
 827  * Cancel a response.  Applies to a block response.
 828  *
 829  * @param responseHandle Response handle set by stack in OCServerResponse after
 830  *                       OCDoResponse is called.
 831  *
 832  * @return ::OC_STACK_OK on success, some other value upon failure.
 833  */
 834 OCStackResult OCCancelResponse(OCResponseHandle responseHandle);
 835
 836 //Utility methods
 837
 838 /**
 839  * This method is used to retrieved the IPv4 address from OCDev address
 840  * data structure.
 841  *
 842  * @param ipAddr OCDevAddr address.
 843  * @param a first byte of IPv4 address.
 844  * @param b second byte of IPv4 address.
 845  * @param c third byte of IPv4 address.
 846  * @param d fourth byte of IPv4 address.
 847  * @return ::OC_STACK_OK on success, some other value upon failure.
 848  */
 849 int32_t OCDevAddrToIPv4Addr(OCDevAddr *ipAddr, uint8_t *a, uint8_t *b,
 850             uint8_t *c, uint8_t *d );
 851
 852 /**
 853  * This method is used to retrieve the port number from OCDev address
 854  * data structure.
 855  *
 856  * @param ipAddr OCDevAddr address.
 857  * @param port Port number.
 858  * @return ::OC_STACK_OK on success, some other value upon failure.
 859  */
 860 int32_t OCDevAddrToPort(OCDevAddr *ipAddr, uint16_t *port);
 861
 862 #ifdef __cplusplus
 863 }
 864 #endif // __cplusplus
 865
 866 #endif /* OCSTACK_H_ */
 867
 868