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