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