resource/include/IServerWrapper.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_SERVER_WRAPPER_H_
  22 #define OC_I_SERVER_WRAPPER_H_
  23
  24 #include <memory>
  25 #include <string>
  26
  27 #include <OCResourceRequest.h>
  28 #include <OCResourceResponse.h>
  29 #include <OCException.h>
  30 #include <OCApi.h>
  31
  32 namespace OC
  33 {
  34     class IServerWrapper
  35     {
  36     protected:
  37
  38     public:
  39         typedef std::shared_ptr<IServerWrapper> Ptr;
  40
  41         IServerWrapper()
  42         {}
  43
  44         virtual ~IServerWrapper(){};
  45
  46         virtual OCStackResult registerResource(
  47                     OCResourceHandle& resourceHandle,
  48                     std::string& resourceURI,
  49                     const std::string& resourceTypeName,
  50                     const std::string& resourceInterface,
  51                     EntityHandler& entityHandler,
  52                     uint8_t resourceProperty) = 0;
  53
  54         // @deprecated: Use setPropertyValue instead.
  55         virtual OCStackResult registerDeviceInfo(
  56                     const OCDeviceInfo deviceInfo) = 0;
  57
  58         virtual OCStackResult registerPlatformInfo(
  59                     const OCPlatformInfo PlatformInfo) = 0;
  60
  61         virtual OCStackResult unregisterResource(
  62                     const OCResourceHandle& resourceHandle) = 0;
  63         virtual OCStackResult bindTypeToResource(
  64                     const OCResourceHandle& resourceHandle,
  65                     const std::string& resourceTypeName) = 0;
  66
  67         virtual OCStackResult bindInterfaceToResource(
  68                     const OCResourceHandle& resourceHandle,
  69                     const std::string& resourceInterfaceName) = 0;
  70
  71         virtual OCStackResult startPresence(const unsigned int seconds) = 0;
  72
  73         virtual OCStackResult stopPresence() = 0;
  74
  75         virtual OCStackResult setDefaultDeviceEntityHandler(EntityHandler entityHandler) = 0;
  76
  77         virtual OCStackResult sendResponse(const std::shared_ptr<OCResourceResponse> pResponse) = 0;
  78
  79         virtual OCStackResult setPropertyValue(OCPayloadType type, const std::string& tag,
  80                     const std::string& value) = 0;
  81         virtual OCStackResult getPropertyValue(OCPayloadType type, const std::string& tag,
  82                     std::string& value) = 0;
  83         virtual OCStackResult getPropertyList(OCPayloadType type, const std::string& tag,
  84                     std::vector<std::string>& value) = 0;
  85
  86         virtual OCStackResult stop() = 0;
  87
  88         virtual OCStackResult start() = 0;
  89     };
  90 }
  91
  92 #endif