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 /**
  22  * @file
  23  *
  24  * Implementation of the OCPlatform functionality. It contains a singleton
  25  * interface that is used only by the OCPlatform namespace and is the
  26  * central entrance to the stack.
  27  */
  28
  29 #ifndef OC_PLATFORM_IMPL_H_
  30 #define OC_PLATFORM_IMPL_H_
  31
  32 #include <map>
  33
  34 #include "OCApi.h"
  35 #include "OCResource.h"
  36 #include "WrapperFactory.h"
  37 #include "OCResourceRequest.h"
  38 #include "OCResourceResponse.h"
  39 #include "OCRepresentation.h"
  40 #include "OCDirectPairing.h"
  41
  42 #ifdef WITH_CLOUD
  43 #include "OCAccountManager.h"
  44 #endif
  45
  46 #include "oc_logger.hpp"
  47
  48 namespace OC
  49 {
  50     class OCPlatform_impl
  51     {
  52     private:
  53         static PlatformConfig& globalConfig();
  54     public:
  55         static void Configure(const PlatformConfig& config);
  56
  57         static OCPlatform_impl& Instance();
  58
  59     public:
  60         // typedef for handle to cancel presence info with
  61         typedef OCDoHandle OCPresenceHandle;
  62
  63         virtual ~OCPlatform_impl(void);
  64
  65         OCStackResult notifyAllObservers(OCResourceHandle resourceHandle);
  66
  67         OCStackResult notifyAllObservers(OCResourceHandle resourceHandle, QualityOfService QoS);
  68
  69         OCStackResult notifyListOfObservers(
  70                     OCResourceHandle resourceHandle,
  71                     ObservationIds& observationIds,
  72                     const std::shared_ptr<OCResourceResponse> responsePtr);
  73
  74         OCStackResult notifyListOfObservers(
  75                     OCResourceHandle resourceHandle,
  76                     ObservationIds& observationIds,
  77                     const std::shared_ptr<OCResourceResponse> responsePtr,
  78                     QualityOfService QoS);
  79
  80         OCStackResult findResource(const std::string& host, const std::string& resourceURI,
  81                     OCConnectivityType connectivityType, FindCallback resourceHandler);
  82
  83         OCStackResult findResource(const std::string& host, const std::string& resourceURI,
  84                     OCConnectivityType connectivityType, FindCallback resourceHandler,
  85                     QualityOfService QoS);
  86
  87         OCStackResult findResource(const std::string& host, const std::string& resourceURI,
  88                     OCConnectivityType connectivityType, FindCallback resourceHandler,
  89                     FindErrorCallback errorHandler);
  90
  91         OCStackResult findResource(const std::string& host, const std::string& resourceURI,
  92                     OCConnectivityType connectivityType, FindCallback resourceHandler,
  93                     FindErrorCallback errorHandler, QualityOfService QoS);
  94
  95         OCStackResult findResourceList(const std::string& host, const std::string& resourceURI,
  96                     OCConnectivityType connectivityType, FindResListCallback resourceHandler,
  97                     QualityOfService QoS);
  98
  99         OCStackResult getDeviceInfo(const std::string& host, const std::string& deviceURI,
 100                     OCConnectivityType connectivityType, FindDeviceCallback deviceInfoHandler);
 101
 102         OCStackResult getDeviceInfo(const std::string& host, const std::string& deviceURI,
 103                     OCConnectivityType connectivityType, FindDeviceCallback deviceInfoHandler,
 104                     QualityOfService QoS);
 105
 106         OCStackResult getPlatformInfo(const std::string& host, const std::string& platformURI,
 107                     OCConnectivityType connectivityType, FindPlatformCallback platformInfoHandler);
 108
 109         OCStackResult getPlatformInfo(const std::string& host, const std::string& platformURI,
 110                     OCConnectivityType connectivityType, FindPlatformCallback platformInfoHandler,
 111                     QualityOfService QoS);
 112
 113         /**
 114          * API for Device Discovery
 115          *
 116          * @param host Host IP Address. If null or empty, Multicast is performed.
 117          * @param deviceURI Uri containing address to the virtual device in C Stack
 118          *                       ("/oic/d")
 119          * @param deviceInfoHandler device discovery callback
 120          * @param QualityOfService the quality of communication
 121          * @return Returns ::OC_STACK_OK if success.
 122          * @note OCStackResult is defined in ocstack.h.
 123          */
 124         OCStackResult getDeviceInfo(const std::string& host, const std::string& deviceURI,
 125                     FindDeviceCallback deviceInfoHandler);
 126         OCStackResult getDeviceInfo(const std::string& host, const std::string& deviceURI,
 127                     FindDeviceCallback deviceInfoHandler, QualityOfService QoS);
 128
 129         /**
 130          * API for Platform Discovery
 131          *
 132          * @param host Host IP Address. If null or empty, Multicast is performed.
 133          * @param platformURI Uri containing address to the virtual platform in C Stack
 134          *                       ("/oic/p")
 135          * @param platformInfoHandler platform discovery callback
 136          * @param QualityOfService the quality of communication
 137          * @return Returns ::OC_STACK_OK if success.
 138          * @note OCStackResult is defined in ocstack.h.
 139          */
 140         OCStackResult getPlatformInfo(const std::string& host, const std::string& platformURI,
 141                     FindPlatformCallback platformInfoHandler);
 142         OCStackResult getPlatformInfo(const std::string& host, const std::string& platformURI,
 143                     FindPlatformCallback platformInfoHandler, QualityOfService QoS);
 144
 145         OCStackResult setPropertyValue(OCPayloadType type, const std::string& tag, const std::string& value);
 146         OCStackResult setPropertyValue(OCPayloadType type, const std::string& tag, const std::vector<std::string>& value);
 147         OCStackResult getPropertyValue(OCPayloadType type, const std::string& tag, std::string& value);
 148
 149         /**
 150         * This API registers a resource with the server
 151         * @note This API applies to server side only.
 152         *
 153         * @param resourceHandle Upon successful registration, resourceHandle will be filled
 154         * @param resourceURI The URI of the resource. Example: "a/light". See NOTE below
 155         * @param resourceTypeName The resource type. Example: "light"
 156         * @param resourceInterface The resource interface (whether it is collection etc).
 157         * @param entityHandler entity handler callback.
 158         * @param resourceProperty indicates the property of the resource. Defined in ocstack.h.
 159         * setting resourceProperty as OC_DISCOVERABLE will allow Discovery of this resource
 160         * setting resourceProperty as OC_OBSERVABLE will allow observation
 161         * settings resourceProperty as OC_DISCOVERABLE | OC_OBSERVABLE will allow both discovery
 162         * and observation
 163         *
 164         * @return Returns ::OC_STACK_OK if success.
 165         * @note "a/light" is a relative URI.
 166         * Above relative URI will be prepended (by core) with a host IP + namespace "oc"
 167         * Therefore, fully qualified URI format would be //HostIP-Address/namespace/relativeURI"
 168         * Example, a relative URI: 'a/light' will result in a fully qualified URI:
 169         *   //192.168.1.1/oic/a/light"
 170         * First parameter can take a relative URI and core will take care of preparing the fully
 171         * qualified URI OR
 172         * first parameter can take fully qualified URI and core will take that as is for further
 173         * operations
 174         * @note OCStackResult is defined in ocstack.h.
 175         */
 176         OCStackResult registerResource(OCResourceHandle& resourceHandle,
 177                         std::string& resourceURI,
 178                         const std::string& resourceTypeName,
 179                         const std::string& resourceInterface,
 180                         EntityHandler entityHandler,
 181                         uint8_t resourceProperty);
 182
 183         OCStackResult registerResource(OCResourceHandle& resourceHandle,
 184                         const std::shared_ptr<OCResource> resource);
 185
 186         /**
 187          * This API registers all the device specific information
 188          *
 189          * @param deviceInfo Structure containing all the device related information
 190          *
 191          * @return Returns ::OC_STACK_OK if success
 192          * @note OCDeviceInfo is defined in OCStack.h
 193          */
 194         OCStackResult registerDeviceInfo(const OCDeviceInfo deviceInfo);
 195
 196         /**
 197          * This API registers all the platform specific information
 198          *
 199          * @param platformInfo Structure containing all the platform related information
 200          *
 201          * @return Returns ::OC_STACK_OK if success
 202          * @note OCPlatformInfo is defined in OCStack.h
 203          */
 204         OCStackResult registerPlatformInfo(const OCPlatformInfo platformInfo);
 205
 206         OCStackResult setDefaultDeviceEntityHandler(EntityHandler entityHandler);
 207
 208         OCStackResult unregisterResource(const OCResourceHandle& resourceHandle) const;
 209
 210         OCStackResult bindResource(const OCResourceHandle collectionHandle,
 211                     const OCResourceHandle resourceHandle);
 212
 213         OCStackResult bindResources(const OCResourceHandle collectionHandle,
 214                     const std::vector<OCResourceHandle>& addedResourceHandleList);
 215
 216         OCStackResult unbindResource(const OCResourceHandle collectionHandle,
 217                     const OCResourceHandle resourceHandle);
 218
 219         OCStackResult unbindResources(const OCResourceHandle collectionHandle,
 220                         const std::vector<OCResourceHandle>& resourceHandleList);
 221
 222         OCStackResult bindTypeToResource(const OCResourceHandle& resourceHandle,
 223                         const std::string& resourceTypeName) const;
 224
 225         OCStackResult bindInterfaceToResource(const OCResourceHandle& resourceHandle,
 226                         const std::string& resourceInterfaceName) const;
 227
 228         OCStackResult startPresence(const unsigned int ttl);
 229
 230         OCStackResult stopPresence();
 231
 232         OCStackResult subscribePresence(OCPresenceHandle& presenceHandle, const std::string& host,
 233                         OCConnectivityType connectivityType, SubscribeCallback presenceHandler);
 234
 235         OCStackResult subscribePresence(OCPresenceHandle& presenceHandle, const std::string& host,
 236                         const std::string& resourceType, OCConnectivityType connectivityType,
 237                         SubscribeCallback presenceHandler);
 238         OCStackResult unsubscribePresence(OCPresenceHandle presenceHandle);
 239
 240 #ifdef WITH_CLOUD
 241         OCStackResult subscribeDevicePresence(OCPresenceHandle& presenceHandle,
 242                                               const std::string& host,
 243                                               const std::vector<std::string>& di,
 244                                               OCConnectivityType connectivityType,
 245                                               ObserveCallback callback);
 246 #endif
 247
 248         OCResource::Ptr constructResourceObject(const std::string& host, const std::string& uri,
 249                         OCConnectivityType connectivityType, bool isObservable,
 250                         const std::vector<std::string>& resourceTypes,
 251                         const std::vector<std::string>& interfaces);
 252         OCStackResult sendResponse(const std::shared_ptr<OCResourceResponse> pResponse);
 253         std::weak_ptr<std::recursive_mutex> csdkLock();
 254
 255         OCStackResult findDirectPairingDevices(unsigned short waittime,
 256                                          GetDirectPairedCallback callback);
 257
 258         OCStackResult getDirectPairedDevices(GetDirectPairedCallback callback);
 259
 260         OCStackResult doDirectPairing(std::shared_ptr<OCDirectPairing> peer, OCPrm_t pmSel,
 261                                          const std::string& pinNumber,
 262                                          DirectPairingCallback resultCallback);
 263 #ifdef WITH_CLOUD
 264         OCAccountManager::Ptr constructAccountManagerObject(const std::string& host,
 265                                                             OCConnectivityType connectivityType);
 266 #endif // WITH_CLOUD
 267
 268         OCStackResult getDeviceId(OCUUIdentity *myUuid);
 269
 270         OCStackResult setDeviceId(const OCUUIdentity *myUuid);
 271
 272     private:
 273         PlatformConfig m_cfg;
 274
 275     private:
 276         std::unique_ptr<WrapperFactory> m_WrapperInstance;
 277         IServerWrapper::Ptr m_server;
 278         IClientWrapper::Ptr m_client;
 279         std::shared_ptr<std::recursive_mutex> m_csdkLock;
 280
 281     private:
 282         /**
 283         * Constructor for OCPlatform_impl. Constructs a new OCPlatform_impl from a given
 284         * PlatformConfig with appropriate fields
 285         * @param config PlatformConfig struct which has details such as modeType
 286         * (server/client/both), in-proc/out-of-proc etc.
 287         */
 288         OCPlatform_impl(const PlatformConfig& config);
 289
 290         /**
 291         * Private function to initialize the platform
 292         */
 293         void init(const PlatformConfig& config);
 294
 295         /**
 296         * Private constructor/operators to prevent copying
 297         * of this object
 298         */
 299         OCPlatform_impl(const OCPlatform_impl& other)= delete;
 300         OCPlatform_impl& operator=(const OCPlatform_impl&) = delete;
 301         OCPlatform_impl& operator=(const OCPlatform_impl&&) = delete;
 302     };
 303 }
 304
 305 #endif //__OCPLATFORM_IMPL_H