resource/include/IClientWrapper.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 OC_I_CLIENT_WRAPPER_H_
  22 #define OC_I_CLIENT_WRAPPER_H_
  23
  24 #include <memory>
  25 #include <string>
  26 #include <OCApi.h>
  27
  28 namespace OC
  29 {
  30     class OCPlatform_impl;
  31
  32     class IClientWrapper : public std::enable_shared_from_this<IClientWrapper>
  33     {
  34     protected:
  35
  36     public:
  37         typedef std::shared_ptr<IClientWrapper> Ptr;
  38
  39         IClientWrapper()
  40         {}
  41
  42         virtual OCStackResult ListenForResource(const std::string& serviceUrl,
  43                         const std::string& resourceType,
  44                         OCConnectivityType connectivityType,
  45                         FindCallback& callback,
  46                         QualityOfService QoS) = 0;
  47
  48         virtual OCStackResult ListenErrorForResource(const std::string& serviceUrl,
  49                         const std::string& resourceType,
  50                         OCConnectivityType connectivityType,
  51                         FindCallback& callback,
  52                         FindErrorCallback& errorCallback,
  53                         QualityOfService QoS) = 0;
  54
  55         virtual OCStackResult ListenForDevice(const std::string& serviceUrl,
  56                         const std::string& deviceURI,
  57                         OCConnectivityType connectivityType,
  58                         FindDeviceCallback& callback,
  59                         QualityOfService QoS) = 0;
  60
  61         virtual OCStackResult GetResourceRepresentation(
  62                         const OCDevAddr& devAddr,
  63                         const std::string& uri,
  64                         const QueryParamsMap& queryParams,
  65                         const HeaderOptions& headerOptions,
  66                         GetCallback& callback, QualityOfService QoS)=0;
  67
  68         virtual OCStackResult PutResourceRepresentation(
  69                         const OCDevAddr& devAddr,
  70                         const std::string& uri,
  71                         const OCRepresentation& rep, const QueryParamsMap& queryParams,
  72                         const HeaderOptions& headerOptions,
  73                         PutCallback& callback, QualityOfService QoS) = 0;
  74
  75         virtual OCStackResult PostResourceRepresentation(
  76                         const OCDevAddr& devAddr,
  77                         const std::string& uri,
  78                         const OCRepresentation& rep, const QueryParamsMap& queryParams,
  79                         const HeaderOptions& headerOptions,
  80                         OCConnectivityType connectivityType,
  81                         PostCallback& callback, QualityOfService QoS) = 0;
  82
  83         virtual OCStackResult DeleteResource(
  84                         const OCDevAddr& devAddr,
  85                         const std::string& uri,
  86                         const HeaderOptions& headerOptions,
  87                         DeleteCallback& callback, QualityOfService QoS) = 0;
  88
  89         virtual OCStackResult ObserveResource(
  90                         ObserveType observeType, OCDoHandle* handle,
  91                         const OCDevAddr& devAddr,
  92                         const std::string& uri,
  93                         const QueryParamsMap& queryParams,
  94                         const HeaderOptions& headerOptions, ObserveCallback& callback,
  95                         QualityOfService QoS)=0;
  96
  97         virtual OCStackResult CancelObserveResource(
  98                         OCDoHandle handle,
  99                         const std::string& host,
 100                         const std::string& uri,
 101                         const HeaderOptions& headerOptions,
 102                         QualityOfService QoS)=0;
 103
 104         virtual OCStackResult SubscribePresence(OCDoHandle* handle,
 105                         const std::string& host,
 106                         const std::string& resourceType,
 107                         OCConnectivityType connectivityType,
 108                         SubscribeCallback& presenceHandler)=0;
 109
 110         virtual OCStackResult UnsubscribePresence(OCDoHandle handle) =0;
 111
 112 #ifdef WITH_CLOUD
 113         virtual OCStackResult SubscribeDevicePresence(OCDoHandle* handle,
 114                                                       const std::string& host,
 115                                                       const QueryParamsList& queryParams,
 116                                                       OCConnectivityType connectivityType,
 117                                                       ObserveCallback& callback) = 0;
 118 #endif
 119
 120         virtual OCStackResult GetDefaultQos(QualityOfService& qos) = 0;
 121
 122         virtual OCStackResult FindDirectPairingDevices(unsigned short waittime,
 123                         GetDirectPairedCallback& callback) = 0;
 124
 125         virtual OCStackResult GetDirectPairedDevices(GetDirectPairedCallback& callback) = 0;
 126
 127         virtual OCStackResult DoDirectPairing(std::shared_ptr< OCDirectPairing > peer,
 128                                               const OCPrm_t& pmSel, const std::string& pinNumber,
 129                                               DirectPairingCallback& resultCallback) = 0;
 130
 131 #ifdef WITH_MQ
 132         virtual OCStackResult ListenForMQTopic(
 133             const OCDevAddr& devAddr,
 134             const std::string& resourceUri,
 135             const QueryParamsMap& queryParams, const HeaderOptions& headerOptions,
 136             FindCallback& callback, QualityOfService QoS) = 0;
 137
 138         virtual OCStackResult PutMQTopicRepresentation(
 139             const OCDevAddr& devAddr,
 140             const std::string& uri,
 141             const OCRepresentation& rep,
 142             const QueryParamsMap& queryParams, const HeaderOptions& headerOptions,
 143             MQCreateTopicCallback& callback, QualityOfService QoS) = 0;
 144 #endif
 145         virtual ~IClientWrapper(){}
 146     };
 147 }
 148
 149 #endif
 150