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