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
  22 /**
  23  * @file
  24  *
  25  * This file contains APIs for OIC Stack to be implemented.
  26  */
  27
  28 #ifndef OCSTACK_H_
  29 #define OCSTACK_H_
  30
  31 #include <stdio.h>
  32 #include <stdint.h>
  33 #include "octypes.h"
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif // __cplusplus
  38
  39 /** Macro to use Random port.*/
  40 #define USE_RANDOM_PORT (0)
  41
  42 /*
  43  * Function prototypes
  44  */
  45
  46 /**
  47  * This function Initializes the OC Stack.  Must be called prior to starting the stack.
  48  *
  49  * @param mode            OCMode Host device is client, server, or client-server.
  50  * @param serverFlags     OCTransportFlags Default server transport flags.
  51  * @param clientFlags     OCTransportFlags Default client transport flags.
  52  *
  53  * @return ::OC_STACK_OK on success, some other value upon failure.
  54  */
  55 OCStackResult OCInit1(OCMode mode, OCTransportFlags serverFlags, OCTransportFlags clientFlags);
  56
  57 /**
  58  * This function Initializes the OC Stack.  Must be called prior to starting the stack.
  59  *
  60  * @param ipAddr      IP Address of host device. Deprecated parameter.
  61  * @param port        Port of host device. Deprecated parameter.
  62  * @param mode        OCMode Host device is client, server, or client-server.
  63  *
  64  * @return ::OC_STACK_OK on success, some other value upon failure.
  65  */
  66 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode);
  67
  68 #ifdef RA_ADAPTER
  69 /**
  70  * @brief   Set Remote Access information for XMPP Client.
  71  * @param   raInfo            [IN] remote access info.
  72  *
  73  * @return  ::OC_STACK_OK on success, some other value upon failure.
  74  */
  75 OCStackResult OCSetRAInfo(const OCRAInfo_t *raInfo);
  76 #endif
  77
  78 /**
  79  * This function Stops the OC stack.  Use for a controlled shutdown.
  80  *
  81  * @note: OCStop() performs operations similar to OCStopPresence(), as well as OCDeleteResource() on
  82  * all resources this server is hosting. OCDeleteResource() performs operations similar to
  83  * OCNotifyAllObservers() to notify all client observers that the respective resource is being
  84  * deleted.
  85  *
  86  * @return ::OC_STACK_OK on success, some other value upon failure.
  87  */
  88 OCStackResult OCStop();
  89
  90 /**
  91  * This function starts receiving the multicast traffic. This can be only called
  92  * when stack is in OC_STACK_INITIALIZED state but device is not receiving multicast
  93  * traffic.
  94  *
  95  * @return ::OC_STACK_OK on success, some other value upon failure.
  96  */
  97 OCStackResult OCStartMulticastServer();
  98
  99 /**
 100  * This function stops receiving the multicast traffic. The rest of the stack
 101  * keeps working and no resource are deleted. Device can still receive the unicast
 102  * traffic. Once this is set, no response to multicast /oic/res will be sent by the
 103  * device. This is to be used for devices that uses other entity to push resources.
 104  *
 105  * @return ::OC_STACK_OK on success, some other value upon failure.
 106  */
 107 OCStackResult OCStopMulticastServer();
 108
 109 /**
 110  * This function is Called in main loop of OC client or server.
 111  * Allows low-level processing of stack services.
 112  *
 113  * @return ::OC_STACK_OK on success, some other value upon failure.
 114  */
 115 OCStackResult OCProcess();
 116
 117 /**
 118  * This function discovers or Perform requests on a specified resource
 119  * (specified by that Resource's respective URI).
 120  *
 121  * @param handle            To refer to the request sent out on behalf of
 122  *                          calling this API. This handle can be used to cancel this operation
 123  *                          via the OCCancel API.
 124  *                          @note: This reference is handled internally, and should not be free'd by
 125  *                          the consumer.  A NULL handle is permitted in the event where the caller
 126  *                          has no use for the return value.
 127  * @param method            To perform on the resource.
 128  * @param requestUri       URI of the resource to interact with. (Address prefix is deprecated in
 129  *                          favor of destination.)
 130  * @param destination       Complete description of destination.
 131  * @param payload           Encoded request payload.
 132  * @param connectivityType  Modifier flags when destination is not given.
 133  * @param qos               Quality of service. Note that if this API is called on a uri with the
 134  *                          well-known multicast IP address, the qos will be forced to ::OC_LOW_QOS
 135  *                          since it is impractical to send other QOS levels on such addresses.
 136  * @param cbData            Asynchronous callback function that is invoked by the stack when
 137  *                          discovery or resource interaction is received. The discovery could be
 138  *                          related to filtered/scoped/particular resource. The callback is
 139  *                          generated for each response received.
 140  * @param options           The address of an array containing the vendor specific header options
 141  *                          to be sent with the request.
 142  * @param numOptions        Number of header options to be included.
 143  *
 144  * @note: Presence subscription amendments (i.e. adding additional resource type filters by calling
 145  * this API again) require the use of the same base URI as the original request to successfully
 146  * amend the presence filters.
 147  *
 148  * @return ::OC_STACK_OK on success, some other value upon failure.
 149  */
 150 OCStackResult OCDoResource(OCDoHandle *handle,
 151                             OCMethod method,
 152                             const char *requestUri,
 153                             const OCDevAddr *destination,
 154                             OCPayload* payload,
 155                             OCConnectivityType connectivityType,
 156                             OCQualityOfService qos,
 157                             OCCallbackData *cbData,
 158                             OCHeaderOption *options,
 159                             uint8_t numOptions);
 160 /**
 161  * This function cancels a request associated with a specific @ref OCDoResource invocation.
 162  *
 163  * @param handle       Used to identify a specific OCDoResource invocation.
 164  * @param qos          Used to specify Quality of Service(read below).
 165  * @param options      Used to specify vendor specific header options when sending
 166  *                     explicit observe cancellation.
 167  * @param numOptions   Number of header options to be included.
 168  *
 169  * @return ::OC_STACK_OK on success, some other value upon failure.
 170  */
 171 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
 172         uint8_t numOptions);
 173
 174 /**
 175  * Register Persistent storage callback.
 176  * @param   persistentStorageHandler  Pointers to open, read, write, close & unlink handlers.
 177  *
 178  * @return
 179  *     OC_STACK_OK                    No errors; Success.
 180  *     OC_STACK_INVALID_PARAM         Invalid parameter.
 181  */
 182 OCStackResult OCRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler);
 183
 184 #ifdef WITH_PRESENCE
 185 /**
 186  * When operating in  OCServer or  OCClientServer mode,
 187  * this API will start sending out presence notifications to clients via multicast.
 188  * Once this API has been called with a success, clients may query for this server's presence and
 189  * this server's stack will respond via multicast.
 190  *
 191  * Server can call this function when it comes online for the first time, or when it comes back
 192  * online from offline mode, or when it re enters network.
 193  *
 194  * @param ttl         Time To Live in seconds.
 195  *                    @note: If ttl is '0', then the default stack value will be used (60 Seconds).
 196  *                    If ttl is greater than ::OC_MAX_PRESENCE_TTL_SECONDS, then the ttl will be
 197  *                    set to ::OC_MAX_PRESENCE_TTL_SECONDS.
 198  *
 199  * @return ::OC_STACK_OK on success, some other value upon failure.
 200  */
 201 OCStackResult OCStartPresence(const uint32_t ttl);
 202
 203 /**
 204  * When operating in OCServer or OCClientServer mode, this API will stop sending
 205  * out presence notifications to clients via multicast.
 206  * Once this API has been called with a success this server's stack will not respond to clients
 207  * querying for this server's presence.
 208  *
 209  * Server can call this function when it is terminating, going offline, or when going
 210  * away from network.
 211  *
 212  * @return ::OC_STACK_OK on success, some other value upon failure.
 213  */
 214
 215 OCStackResult OCStopPresence();
 216 #endif
 217
 218
 219 /**
 220  * This function sets default device entity handler.
 221  *
 222  * @param entityHandler      Entity handler function that is called by ocstack to handle requests
 223  *                           for any undefined resources or default actions.If NULL is passed it
 224  *                           removes the device default entity handler.
 225  * @param callbackParameter  Parameter passed back when entityHandler is called.
 226  *
 227  * @return ::OC_STACK_OK on success, some other value upon failure.
 228  */
 229 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler, void* callbackParameter);
 230
 231 /**
 232  * This function sets device information.
 233  *
 234  * @param deviceInfo   Structure passed by the server application containing the device information.
 235  *
 236  * @return
 237  *     ::OC_STACK_OK               no errors.
 238  *     ::OC_STACK_INVALID_PARAM    invalid parameter.
 239  *     ::OC_STACK_ERROR            stack process error.
 240  */
 241 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo);
 242
 243 /**
 244  * This function sets platform information.
 245  *
 246  * @param platformInfo   Structure passed by the server application containing
 247  *                       the platform information.
 248  *
 249  *
 250  * @return
 251  *     ::OC_STACK_OK               no errors.
 252  *     ::OC_STACK_INVALID_PARAM    invalid parameter.
 253  *     ::OC_STACK_ERROR            stack process error.
 254  */
 255 OCStackResult OCSetPlatformInfo(OCPlatformInfo platformInfo);
 256
 257 /**
 258  * This function creates a resource.
 259  *
 260  * @param handle                Pointer to handle to newly created resource. Set by ocstack and
 261  *                              used to refer to resource.
 262  * @param resourceTypeName      Name of resource type.  Example: "core.led".
 263  * @param resourceInterfaceName Name of resource interface.  Example: "core.rw".
 264  * @param uri                   URI of the resource.  Example:  "/a/led".
 265  * @param entityHandler         Entity handler function that is called by ocstack to handle
 266  *                              requests, etc.
 267  *                              NULL for default entity handler.
 268  * @param callbackParam     parameter passed back when entityHandler is called.
 269  * @param resourceProperties    Properties supported by resource.
 270  *                              Example: ::OC_DISCOVERABLE|::OC_OBSERVABLE.
 271  *
 272  * @return ::OC_STACK_OK on success, some other value upon failure.
 273  */
 274 OCStackResult OCCreateResource(OCResourceHandle *handle,
 275                                const char *resourceTypeName,
 276                                const char *resourceInterfaceName,
 277                                const char *uri,
 278                                OCEntityHandler entityHandler,
 279                                void* callbackParam,
 280                                uint8_t resourceProperties);
 281
 282
 283 /**
 284  * This function adds a resource to a collection resource.
 285  *
 286  * @param collectionHandle    Handle to the collection resource.
 287  * @param resourceHandle      Handle to resource to be added to the collection resource.
 288  *
 289  * @return ::OC_STACK_OK on success, some other value upon failure.
 290  */
 291 OCStackResult OCBindResource(OCResourceHandle collectionHandle, OCResourceHandle resourceHandle);
 292
 293 /**
 294  * This function removes a resource from a collection resource.
 295  *
 296  * @param collectionHandle   Handle to the collection resource.
 297  * @param resourceHandle     Handle to resource to be removed from the collection resource.
 298  *
 299  * @return ::OC_STACK_OK on success, some other value upon failure.
 300  */
 301 OCStackResult OCUnBindResource(OCResourceHandle collectionHandle, OCResourceHandle resourceHandle);
 302
 303 /**
 304  * This function binds a resource type to a resource.
 305  *
 306  * @param handle            Handle to the resource.
 307  * @param resourceTypeName  Name of resource type.  Example: "core.led".
 308  *
 309  * @return ::OC_STACK_OK on success, some other value upon failure.
 310  */
 311 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
 312                                            const char *resourceTypeName);
 313 /**
 314  * This function binds a resource interface to a resource.
 315  *
 316  * @param handle                  Handle to the resource.
 317  * @param resourceInterfaceName   Name of resource interface.  Example: "core.rw".
 318  *
 319  * @return ::OC_STACK_OK on success, some other value upon failure.
 320  */
 321 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
 322                                                 const char *resourceInterfaceName);
 323
 324 /**
 325  * This function binds an entity handler to the resource.
 326  *
 327  * @param handle            Handle to the resource that the contained resource is to be bound.
 328  * @param entityHandler     Entity handler function that is called by ocstack to handle requests.
 329  * @param callbackParameter Context parameter that will be passed to entityHandler.
 330  *
 331  * @return ::OC_STACK_OK on success, some other value upon failure.
 332  */
 333 OCStackResult OCBindResourceHandler(OCResourceHandle handle, OCEntityHandler entityHandler,
 334                                         void *callbackParameter);
 335
 336 /**
 337  * This function gets the number of resources that have been created in the stack.
 338  *
 339  * @param numResources    Pointer to count variable.
 340  *
 341  * @return ::OC_STACK_OK on success, some other value upon failure.
 342  */
 343 OCStackResult OCGetNumberOfResources(uint8_t *numResources);
 344
 345 /**
 346  * This function gets a resource handle by index.
 347  *
 348  * @param index   Index of resource, 0 to Count - 1.
 349  *
 350  * @return Found  resource handle or NULL if not found.
 351  */
 352 OCResourceHandle OCGetResourceHandle(uint8_t index);
 353
 354 /**
 355  * This function deletes resource specified by handle.  Deletes resource and all
 356  * resource type and resource interface linked lists.
 357  *
 358  * @note: OCDeleteResource() performs operations similar to OCNotifyAllObservers() to notify all
 359  * client observers that "this" resource is being deleted.
 360  *
 361  * @param handle          Handle of resource to be deleted.
 362  *
 363  * @return ::OC_STACK_OK on success, some other value upon failure.
 364  */
 365 OCStackResult OCDeleteResource(OCResourceHandle handle);
 366
 367 /**
 368  * Get a string representation the server instance ID.
 369  * The memory is managed internal to this function, so freeing externally will result
 370  * in a runtime error.
 371  * Note: This will NOT seed the RNG, so it must be called after the RNG is seeded.
 372  * This is done automatically during the OCInit process,
 373  * so ensure that this call is done after that.
 374  *
 375  * @return A string representation  the server instance ID.
 376  */
 377 const char* OCGetServerInstanceIDString(void);
 378
 379 /**
 380  * This function gets the URI of the resource specified by handle.
 381  *
 382  * @param handle     Handle of resource.
 383  *
 384  * @return URI string if resource found or NULL if not found.
 385  */
 386 const char *OCGetResourceUri(OCResourceHandle handle);
 387
 388 /**
 389  * This function gets the properties of the resource specified by handle.
 390  *
 391  * @param handle                Handle of resource.
 392  *
 393  * @return OCResourceProperty   Bitmask or -1 if resource is not found.
 394  *
 395  * @note that after a resource is created, the OC_ACTIVE property is set for the resource by the
 396  * stack.
 397  */
 398 OCResourceProperty OCGetResourceProperties(OCResourceHandle handle);
 399
 400 /**
 401  * This function gets the number of resource types of the resource.
 402  *
 403  * @param handle            Handle of resource.
 404  * @param numResourceTypes  Pointer to count variable.
 405  *
 406  * @return ::OC_STACK_OK on success, some other value upon failure.
 407  */
 408 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle, uint8_t *numResourceTypes);
 409
 410 /**
 411  * This function gets name of resource type of the resource.
 412  *
 413  * @param handle       Handle of resource.
 414  * @param index        Index of resource, 0 to Count - 1.
 415  *
 416  * @return Resource type name if resource found or NULL if resource not found.
 417  */
 418 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index);
 419
 420 /**
 421  * This function gets the number of resource interfaces of the resource.
 422  *
 423  * @param handle                 Handle of resource.
 424  * @param numResourceInterfaces  Pointer to count variable.
 425  *
 426  * @return ::OC_STACK_OK on success, some other value upon failure.
 427  */
 428 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
 429         uint8_t *numResourceInterfaces);
 430
 431 /**
 432  * This function gets name of resource interface of the resource.
 433  *
 434  * @param handle      Handle of resource.
 435  * @param index       Index of resource, 0 to Count - 1.
 436  *
 437  * @return Resource interface name if resource found or NULL if resource not found.
 438  */
 439 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index);
 440
 441 /**
 442  * This function gets methods of resource interface of the resource.
 443  *
 444  * @param handle      Handle of resource.
 445  * @param index       Index of resource, 0 to Count - 1.
 446  *
 447  * @return Allowed methods if resource found or NULL if resource not found.
 448  */
 449 uint8_t OCGetResourceInterfaceAllowedMethods(OCResourceHandle handle, uint8_t index);
 450
 451 /**
 452  * This function gets resource handle from the collection resource by index.
 453  *
 454  * @param collectionHandle   Handle of collection resource.
 455  * @param index              Index of contained resource, 0 to Count - 1.
 456  *
 457  * @return Handle to contained resource if resource found or NULL if resource not found.
 458  */
 459 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
 460         uint8_t index);
 461
 462 /**
 463  * This function gets the entity handler for a resource.
 464  *
 465  * @param handle            Handle of resource.
 466  *
 467  * @return Entity handler if resource found or NULL resource not found.
 468  */
 469 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle);
 470
 471 /**
 472  * This function notify all registered observers that the resource representation has
 473  * changed. If observation includes a query the client is notified only if the query is valid after
 474  * the resource representation has changed.
 475  *
 476  * @param handle   Handle of resource.
 477  * @param qos      Desired quality of service for the observation notifications.
 478  *
 479  * @return ::OC_STACK_OK on success, some other value upon failure.
 480  */
 481 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos);
 482
 483 /**
 484  * Notify specific observers with updated value of representation.
 485  * Before this API is invoked by entity handler it has finished processing
 486  * queries for the associated observers.
 487  *
 488  * @param handle                    Handle of resource.
 489  * @param obsIdList                 List of observation IDs that need to be notified.
 490  * @param numberOfIds               Number of observation IDs included in obsIdList.
 491  * @param payload                   Object representing the notification
 492  * @param qos                       Desired quality of service of the observation notifications.
 493  *
 494  * @note: The memory for obsIdList and payload is managed by the entity invoking the API.
 495  * The maximum size of the notification is 1015 bytes for non-Arduino platforms. For Arduino
 496  * the maximum size is 247 bytes.
 497  *
 498  * @return ::OC_STACK_OK on success, some other value upon failure.
 499  */
 500 OCStackResult
 501 OCNotifyListOfObservers (OCResourceHandle handle,
 502                             OCObservationId  *obsIdList,
 503                             uint8_t          numberOfIds,
 504                             const OCRepPayload *payload,
 505                             OCQualityOfService qos);
 506
 507
 508 /**
 509  * This function sends a response to a request.
 510  * The response can be a normal, slow, or block (i.e. a response that
 511  * is too large to be sent in a single PDU and must span multiple transmissions).
 512  *
 513  * @param response   Pointer to structure that contains response parameters.
 514  *
 515  * @return ::OC_STACK_OK on success, some other value upon failure.
 516  */
 517 OCStackResult OCDoResponse(OCEntityHandlerResponse *response);
 518
 519 //#ifdef DIRECT_PAIRING
 520 /**
 521  * The function is responsible for discovery of direct-pairing device is current subnet. It will list
 522  * all the device in subnet which support direct-pairing.
 523  * Caller must NOT free returned constant pointer
 524  *
 525  * @param[in] timeout Timeout in seconds, value till which function will listen to responses from
 526  *                    client before returning the list of devices.
 527  * @return OCDirectPairingDev_t pointer in case of success and NULL otherwise.
 528  */
 529 const OCDPDev_t* OCDiscoverDirectPairingDevices(unsigned short waittime);
 530
 531 /**
 532  * The function is responsible for return of paired device list via direct-pairing. It will list
 533  * all the device which is previousely paired with client.
 534  * Caller must NOT free returned constant pointer
 535  *
 536  * @return OCDirectPairingDev_t pointer in case of success and NULL otherwise.
 537  */
 538 const OCDPDev_t* OCGetDirectPairedDevices();
 539
 540 /**
 541  * The function is responsible for establishment of direct-pairing. It will proceed mode negotiation
 542  * and connect PIN based dtls session.
 543  *
 544  * @param[in] peer Target device to establish direct-pairing.
 545  * @param[in] pmSel Selected mode of pairing.
 546  * @param[in] pinNumber PIN number for authentication, pin lenght is defined DP_PIN_LENGTH(8).
 547  * @param[in] resultCallback Callback fucntion to event status of process.
 548  * @return OTM_SUCCESS in case of success and other value otherwise.
 549  */
 550 OCStackResult OCDoDirectPairing(OCDPDev_t* peer, OCPrm_t pmSel, char *pinNumber,
 551                                                      OCDirectPairingCB resultCallback);
 552 //#endif // DIRECT_PAIRING
 553
 554 #ifdef __cplusplus
 555 }
 556 #endif // __cplusplus
 557
 558 #endif /* OCSTACK_H_ */