resource/include/OCPlatform.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 /// @file OCPlatform.h
  22
  23 /// @brief  This file contains the declaration of classes and its members related to
  24 ///         OCPlatform.
  25
  26 #ifndef __OCPLATFORM_H
  27 #define __OCPLATFORM_H
  28 #include <OCApi.h>
  29 #include <OCPlatform_impl.h>
  30 namespace OC
  31 {
  32     /**
  33     * @brief: This namespace contains the main entrance/functionality of the product.
  34     * It may be used with OC::OCPlatform::functionName.  To set a custom configuration,
  35     * the implementer must make a call to OCPlatform::Configure before the first usage
  36     * of a function in this namespace.
  37     */
  38     namespace OCPlatform
  39     {
  40         /**
  41          * API for overwriting the default configuration of the OCPlatform object.
  42          * Note: Any calls made to this AFTER the first call to OCPlatform::Instance
  43          * will have no affect
  44          */
  45         void Configure(const PlatformConfig& config);
  46
  47         // typedef for handle to cancel presence info with
  48         typedef OCDoHandle OCPresenceHandle;
  49
  50         /**
  51         * API for notifying base that resource's attributes have changed.
  52         *
  53         * @param OCResourceHandle resource handle of the resource
  54         * @param QualityOfService the quality of communication
  55         *
  56         * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
  57         * NOTE: This API is for server side only.
  58         * NOTE: OCResourceHandle is defined in ocstack.h.
  59         * NOTE: OCStackResult is defined in ocstack.h.
  60         */
  61         OCStackResult notifyAllObservers(OCResourceHandle resourceHandle);
  62         OCStackResult notifyAllObservers(OCResourceHandle resourceHandle, QualityOfService QoS);
  63
  64         /**
  65         * API for notifying only specific clients that resource's attributes have changed.
  66         *
  67         * @param OCResourceHandle resource handle of the resource
  68         * @param observationIds std vector of observationIds. These set of ids are ones which
  69         * which will be notified upon resource change.
  70         * @param responsePtr OCResourceResponse pointer used by app to fill the response for this
  71         * resource change.
  72         * @param QualityOfService the quality of communication
  73         *
  74         * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
  75         *
  76         * NOTE: This API is for server side only.
  77         * NOTE: OCResourceHandle is defined in ocstack.h.
  78         * NOTE: OCStackResult is defined in ocstack.h.
  79         */
  80         OCStackResult notifyListOfObservers(
  81                     OCResourceHandle resourceHandle,
  82                     ObservationIds& observationIds,
  83                     const std::shared_ptr<OCResourceResponse> responsePtr);
  84         OCStackResult notifyListOfObservers(
  85                     OCResourceHandle resourceHandle,
  86                     ObservationIds& observationIds,
  87                     const std::shared_ptr<OCResourceResponse> responsePtr,
  88                     QualityOfService QoS);
  89
  90         /**
  91         * API for Service and Resource Discovery.
  92         * NOTE: This API applies to client side only.
  93         *
  94         * @param host - Host IP Address of a service to direct resource discovery query. If null or
  95         *        empty, performs multicast resource discovery query
  96         * @param resourceURI - name of the resource. If null or empty, performs search for all
  97         *       resource names
  98         * @param handler - Handles callbacks, success states and failure states.
  99         *
 100         *        Four modes of discovery defined as follows:
 101         *        (NULL/Empty, NULL/Empty) - Performs ALL service discovery AND ALL resource
 102         *           discovery.
 103         *        (NULL/Empty, Not Empty) - Performs query for a filtered/scoped/particular
 104         *                                   resource(s) from ALL services.
 105         *        (Not Empty, NULL/Empty) - Performs ALL resource discovery on a particular service.
 106         *        (Not Empty, Not Empty) - Performs query for a filtered/scoped/particular
 107         *                                   resource(s)
 108         *                                  from a particular service.
 109         * @param QualityOfService the quality of communication
 110         *
 111         * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
 112         * NOTE: First parameter 'host' currently represents an IP address. This will change in
 113         * future and will refer to endpoint interface so that we can refer to other transports such
 114         * as BTH etc.
 115         * NOTE: OCStackResult is defined in ocstack.h.
 116         */
 117         OCStackResult findResource(const std::string& host, const std::string& resourceURI,
 118                     FindCallback resourceHandler);
 119         OCStackResult findResource(const std::string& host, const std::string& resourceURI,
 120                     FindCallback resourceHandler, QualityOfService QoS);
 121
 122         /**
 123         * This API registers a resource with the server
 124         * NOTE: This API applies to server side only.
 125         *
 126         * @param resourceHandle - Upon successful registration, resourceHandle will be filled
 127         * @param resourceURI - The URI of the resource. Example: "a/light". See NOTE below
 128         * @param resourceTypeName - The resource type. Example: "light"
 129         * @param resourceInterface - The resource interface (whether it is collection etc).
 130         * @param entityHandler - entity handler callback.
 131         * @param resourceProperty - indicates the property of the resource. Defined in ocstack.h.
 132         * setting resourceProperty as OC_DISCOVERABLE will allow Discovery of this resource
 133         * setting resourceProperty as OC_OBSERVABLE will allow observation
 134         * settings resourceProperty as OC_DISCOVERABLE | OC_OBSERVABLE will allow both discovery and
 135         * observation
 136         *
 137         * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
 138         * NOTE: "a/light" is a relative URI.
 139         * Above relative URI will be prepended (by core) with a host IP + namespace "oc"
 140         * Therefore, fully qualified URI format would be //HostIP-Address/namespace/relativeURI"
 141         * Example, a relative URI: 'a/light' will result in a fully qualified URI:
 142         *   //192.168.1.1/oc/a/light"
 143         * First parameter can take a relative URI and core will take care of preparing the fully
 144         * qualified URI OR
 145         * first paramter can take fully qualified URI and core will take that as is for further
 146         * operations
 147         * NOTE: OCStackResult is defined in ocstack.h.
 148         */
 149         OCStackResult registerResource(OCResourceHandle& resourceHandle,
 150                         std::string& resourceURI,
 151                         const std::string& resourceTypeName,
 152                         const std::string& resourceInterface,
 153                         EntityHandler entityHandler,
 154                         uint8_t resourceProperty);
 155
 156         /**
 157          * This API registers a resource with the server
 158          * NOTE: This API applies to server & client side.
 159
 160          * @param resourceHandle - Upon successful registration, resourceHandle will be filled
 161          * @param OCResource - The instance of OCResource that all data filled.
 162          *
 163          * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
 164          */
 165
 166         OCStackResult registerResource(OCResourceHandle& resourceHandle,
 167                         const std::shared_ptr< OCResource > resource);
 168
 169         /**
 170         * Set default device entity handler
 171         *
 172         * @param entityHandler - entity handler to handle requests for
 173         *                        any undefined resources or default actions.
 174         *                        if NULL is passed it removes the device default entity handler.
 175         *
 176         * @return
 177         *     OC_STACK_OK    - no errors
 178         *     OC_STACK_ERROR - stack process error
 179         */
 180         OCStackResult setDefaultDeviceEntityHandler(EntityHandler entityHandler);
 181
 182         /**
 183         * This API unregisters a resource with the server
 184         * NOTE: This API applies to server side only.
 185         *
 186         * @param resourceHandle - This is the resource handle which we which to unregister from the
 187         * server
 188         *
 189         * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.
 190         * NOTE: OCStackResult is defined in ocstack.h.
 191         */
 192         OCStackResult unregisterResource(const OCResourceHandle& resourceHandle);
 193
 194         /**
 195         * Add a resource to a collection resource.
 196         *
 197         * @param collectionHandle - handle to the collection resource
 198         * @param addedResourceHandle - handle to resource to be added to the collection resource
 199         *
 200         * @return OCStackResult return value of this API. Returns OC_STACK_OK if success.<br>
 201         * NOTE: OCStackResult is defined in ocstack.h. <br>
 202         * NOTE: bindResource must be used only after the both collection resource and
 203         * resource to add under a collections are created and respective handles obtained<br>
 204         * <b>Example:</b> <br>
 205         * Step 1: registerResource(homeResourceHandle, "a/home", "home", Link_Interface,
 206         *   entityHandler, OC_DISCOVERABLE | OC_OBSERVABLE);<br>
 207         * Step 2: registerResource(kitchenResourceHandle, "a/kitchen", "kitchen", Link_Interface,
 208         *   entityHandler, OC_DISCOVERABLE | OC_OBSERVABLE);<br>
 209         * Step 3: bindResource(homeResourceHandle, kitchenResourceHandle);<br>
 210         * At the end of Step 3, resource "a/home" will contain a reference to "a/kitchen".<br>
 211         */
 212         OCStackResult bindResource(const OCResourceHandle collectionHandle,
 213                 const OCResourceHandle resourceHandle);
 214
 215         /**
 216         * Add multiple resources to a collection resource.
 217         *
 218         * @param collectionHandle - handle to the collection resource
 219         * @param addedResourceHandleList reference to list of resource handles to be added to the
 220         *   collection resource
 221         *
 222         * @return OCStackResult return value of this API. Returns OC_STACK_OK if success. <br>
 223         * NOTE: OCStackResult is defined in ocstack.h. <br>
 224         * NOTE: bindResources must be used only after the both collection resource and
 225         * list of resources to add under a collection are created and respective handles
 226         * obtained <br>
 227         * <b> Example: </b> <br>
 228         * Step 1: registerResource(homeResourceHandle, "a/home", "home", Link_Interface,
 229         *   homeEntityHandler, OC_DISCOVERABLE | OC_OBSERVABLE);<br>
 230         * Step 2: registerResource(kitchenResourceHandle, "a/kitchen", "kitchen", Link_Interface,
 231         *   kitchenEntityHandler, OC_DISCOVERABLE | OC_OBSERVABLE);<br>
 232         * Step 3: registerResource(roomResourceHandle, "a/room", "room", Link_Interface,
 233         *   roomEntityHandler, OC_DISCOVERABLE | OC_OBSERVABLE);<br>
 234         * Step 4: std::vector<OCResourceHandle> rList; rList.push_back(kitchenResourceHandle);
 235         *   rList.push_back(roomResourceHandle);<br>
 236         * Step 5: bindResource(homeResourceHandle, rList);<br>
 237         * At the end of Step 5, resource "a/home" will contain a references to "a/kitchen" and
 238         *   "a/room" <br>
 239         */
 240         OCStackResult bindResources(const OCResourceHandle collectionHandle,
 241                 const std::vector<OCResourceHandle>& addedResourceHandleList);
 242
 243         /**
 244         * Unbind a resource from a collection resource.
 245         *
 246         * @param collectionHandle - handle to the collection resource
 247         * @param resourceHandle resource handle to be unbound from the collection resource
 248         *
 249         * @return OCStackResult return value of this API. Returns OC_STACK_OK if success. <br>
 250         * NOTE: OCStackResult is defined in ocstack.h.<br>
 251         * NOTE: unbindResource must be used only after the both collection resource and
 252         * resource to unbind from a collection are created and respective handles obtained<br>
 253         * <b> Example </b> <br>
 254         * Step 1: registerResource(homeResourceHandle, "a/home", "home", Link_Interface,
 255         *   entityHandler, OC_DISCOVERABLE | OC_OBSERVABLE);<br>
 256         * Step 2: registerResource(kitchenResourceHandle, "a/kitchen", "kitchen", Link_Interface,
 257         *   entityHandler, OC_DISCOVERABLE | OC_OBSERVABLE);<br>
 258         * Step 3: bindResource(homeResourceHandle, kitchenResourceHandle);<br>
 259         * Step 4: unbindResource(homeResourceHandle, kitchenResourceHandle);<br>
 260         * At the end of Step 4, resource "a/home" will no longer reference "a/kitchen". <br>
 261         */
 262         OCStackResult unbindResource(const OCResourceHandle collectionHandle,
 263                     const OCResourceHandle resourceHandle);
 264
 265         /**
 266         * Unbind resources from a collection resource.
 267         *
 268         * @param collectionHandle - handle to the collection resource
 269         * @param resourceHandleList List of resource handles to be unbound from the collection
 270         *   resource
 271         *
 272         * @return OCStackResult return value of this API. Returns OC_STACK_OK if success. <br>
 273         *
 274         * NOTE: OCStackResult is defined in ocstack.h.<br>
 275         * NOTE: unbindResources must be used only after the both collection resource and
 276         * list of resources resource to unbind from a collection are created and respective handles
 277         *   obtained. <br>
 278         * <b>Example</b> <br>
 279         * Step 1: registerResource(homeResourceHandle, "a/home", "home", Link_Interface,
 280         *   homeEntityHandler, OC_DISCOVERABLE | OC_OBSERVABLE);<br>
 281         * Step 2: registerResource(kitchenResourceHandle, "a/kitchen", "kitchen", Link_Interface,
 282         *   kitchenEntityHandler, OC_DISCOVERABLE | OC_OBSERVABLE);<br>
 283         * Step 3: registerResource(roomResourceHandle, "a/room", "room", Link_Interface,
 284         *   roomEntityHandler, OC_DISCOVERABLE | OC_OBSERVABLE);<br>
 285         * Step 4: std::vector<OCResourceHandle> rList; rList.push_back(kitchenResourceHandle);
 286         *   rList.push_back(roomResourceHandle);<br>
 287         * Step 5: bindResource(homeResourceHandle, rList);<br>
 288         * Step 6: unbindResources(homeResourceHandle, rList);<br>
 289         * At the end of Step 6, resource "a/home" will no longer reference to "a/kitchen" and
 290         *   "a/room"<br>
 291         */
 292         OCStackResult unbindResources(const OCResourceHandle collectionHandle,
 293                         const std::vector<OCResourceHandle>& resourceHandleList);
 294
 295         /**
 296         * Binds a type to a particular resource
 297         * @param resourceHandle - handle to the resource
 298         * @param resourceTypeName - new typename to bind to the resource
 299
 300         * @return OCStackResult - return value of the API. Returns OCSTACK_OK if success <br>
 301         */
 302         OCStackResult bindTypeToResource(const OCResourceHandle& resourceHandle,
 303                         const std::string& resourceTypeName);
 304
 305         /**
 306         * Binds an interface to a particular resource
 307         * @param resourceHandle - handle to the resource
 308         * @param resourceTypeName - new interface  to bind to the resource
 309
 310         * @return OCStackResult - return value of the API. Returns OCSTACK_OK if success <br>
 311         */
 312         OCStackResult bindInterfaceToResource(const OCResourceHandle& resourceHandle,
 313                         const std::string& resourceInterfaceName);
 314
 315
 316         /**
 317         * Start Presence announcements.
 318         *
 319         * @param ttl - time to live
 320         * @return OCStackResult - Returns OCSTACK_OK if success <br>
 321         *
 322         * Server can call this function when it comes online for the
 323         * first time, or when it comes back online from offline mode,
 324         * or when it re enters network.
 325         *
 326         */
 327
 328         OCStackResult startPresence(const unsigned int ttl);
 329
 330         /**
 331         * Stop Presence announcements.
 332         *
 333         * @return OCStackResult - Returns OCSTACK_OK if success <br>
 334         *
 335         * Server can call this function when it is terminating,
 336         * going offline, or when going away from network.
 337         *
 338         */
 339
 340         OCStackResult stopPresence();
 341
 342         /**
 343         * subscribes to a server's presence change events.  By making this subscription,
 344         * every time a server adds/removes/alters a resource, starts or is intentionally
 345         * stopped (potentially more to be added later).
 346         *
 347         * @param presenceHandle - a handle object that can be used to identify this subscription
 348         *               request.  It can be used to unsubscribe from these events in the future.
 349         *               It will be set upon successful return of this method.
 350         * @param host - The IP address/addressable name of the server to subscribe to.
 351         * @param presenceHandler - callback function that will receive notifications/subscription
 352         *               events
 353         *
 354         * @return OCStackResult - return value of the API.  Returns OCSTACK_OK if success <br>
 355         */
 356         OCStackResult subscribePresence(OCPresenceHandle& presenceHandle, const std::string& host,
 357                         SubscribeCallback presenceHandler);
 358
 359         /**
 360         * unsubscribes from a previously subscribed server's presence events. Note that
 361         * you may for a short time still receive events from the server since it may take time
 362         * for the unsubscribe to take effect.
 363         *
 364         * @param presenceHandle - the handle object provided by the subscribePresence call that
 365         *               identifies this subscription.
 366         *
 367         * @return OCStackResult - return value of the API.  Returns OCSTACK_OK if success <br>
 368         */
 369         OCStackResult unsubscribePresence(OCPresenceHandle presenceHandle);
 370
 371         /**
 372         * Creates a resource proxy object so that get/put/observe functionality
 373         * can be used without discovering the object in advance.  Note that the
 374         * consumer of this method needs to provide all of the details required to
 375         * correctly contact and observe the object. If the consumer lacks any of
 376         * this information, they should discover the resource object normally.
 377         * Additionally, you can only create this object if OCPlatform was initialized
 378         * to be a Client or Client/Server.  Otherwise, this will return an empty
 379         * shared ptr.
 380         *
 381         * @param host - a string containing a resolvable host address of the server
 382         *           holding the resource. Currently this should be in the format
 383         *           coap://address:port, though in the future, we expect this to
 384         *           change to //address:port
 385         *
 386         * @param uri - the rest of the resource's URI that will permit messages to be
 387         *           properly routed.  Example: /a/light
 388         *
 389         * @param isObservable - a boolean containing whether the resource supports observation
 390         *
 391         * @param resourceTypes - a collection of resource types implemented by the resource
 392         *
 393         * @param interfaces - a collection of interfaces that the resource supports/implements
 394         * @return OCResource::Ptr - a shared pointer to the new resource object
 395         */
 396         OCResource::Ptr constructResourceObject(const std::string& host, const std::string& uri,
 397                         bool isObservable, const std::vector<std::string>& resourceTypes,
 398                         const std::vector<std::string>& interfaces);
 399
 400
 401
 402     }
 403 }
 404
 405 #endif //__OCPLATFORM_H
 406
 407