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