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