service/notification/cpp-wrapper/consumer/inc/NSConsumerService.h

   1 //******************************************************************\r
   2 //\r
   3 // Copyright 2016 Samsung Electronics All Rights Reserved.\r
   4 //\r
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\r
   6 //\r
   7 // Licensed under the Apache License, Version 2.0 (the "License");\r
   8 // you may not use this file except in compliance with the License.\r
   9 // You may obtain a copy of the License at\r
  10 //\r
  11 //      http://www.apache.org/licenses/LICENSE-2.0\r
  12 //\r
  13 // Unless required by applicable law or agreed to in writing, software\r
  14 // distributed under the License is distributed on an "AS IS" BASIS,\r
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16 // See the License for the specific language governing permissions and\r
  17 // limitations under the License.\r
  18 //\r
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\r
  20 \r
  21 \r
  22 /**\r
  23  * @file\r
  24  *\r
  25  * This file provides C++ Wrapper APIs of Notification Service for Consumer.\r
  26  */\r
  27 \r
  28 #ifndef _NS_CONSUMER_SERVICE_H_\r
  29 #define _NS_CONSUMER_SERVICE_H_\r
  30 \r
  31 #include <list>\r
  32 #include <algorithm>\r
  33 #include "NSProvider.h"\r
  34 #include "NSUtils.h"\r
  35 \r
  36 \r
  37 namespace OIC\r
  38 {\r
  39     namespace Service\r
  40     {\r
  41         /**\r
  42          * @class   NSConsumerService\r
  43          * @brief   This class provides a set of C++APIs for Notification Consumer.\r
  44          */\r
  45         class NSConsumerService\r
  46         {\r
  47 \r
  48             public :\r
  49                 /**\r
  50                      * Consumer uses this callback function to receive the discovered providers\r
  51                      * @param[in] provider        Provider who has the notification resource\r
  52                      */\r
  53                 typedef void (*ProviderDiscoveredCallback)(NSProvider *);\r
  54 \r
  55                 /**\r
  56                       * API for getting the Instance of NSConsumerService class\r
  57                       *\r
  58                       * @return Instance of the "NSConsumerService" class\r
  59                       */\r
  60                 static NSConsumerService *getInstance();\r
  61 \r
  62                 /**\r
  63                       * Initialize notification service for consumer\r
  64                       * @param providerDiscovered Callback function pointers to ProviderDiscoveredCallback,\r
  65                       */\r
  66                 void start(ProviderDiscoveredCallback providerDiscovered);\r
  67 \r
  68                 /**\r
  69                       * Terminate notification service for consumer\r
  70                       */\r
  71                 void stop();\r
  72 \r
  73                 /**\r
  74                      * Request to discover to remote address as parameter.\r
  75                      * @param[in]  serverAddress combined with IP address and port number using delimiter :\r
  76                      * @return  NSResult code of Consumer Service\r
  77                      */\r
  78                 NSResult enableRemoteService(const std::string &serverAddress);\r
  79 \r
  80                 /**\r
  81                       * Request discovery manually\r
  82                       */\r
  83                 void rescanProvider();\r
  84 \r
  85                 /**\r
  86                       *  get the callback for ProviderDiscovered\r
  87                       * @return ProviderDiscoveredCallback callbak set\r
  88                       */\r
  89                 ProviderDiscoveredCallback getProviderDiscoveredCb();\r
  90 \r
  91                 /**\r
  92                       *  request to get NSProvider pointer\r
  93                       * @param id -id as string\r
  94                       *\r
  95                       * @return pointer to NSProvider\r
  96                       */\r
  97                 NSProvider *getProvider(const std::string &id);\r
  98 \r
  99                 /**\r
 100                       *  get list of providers acceted.\r
 101                       * @return m_acceptedProviders -list of accepted providers\r
 102                       */\r
 103                 std::list<NSProvider *> &getAcceptedProviders();\r
 104 \r
 105             private :\r
 106                 ProviderDiscoveredCallback m_providerDiscoveredCb;\r
 107                 std::list<NSProvider *> m_acceptedProviders;\r
 108 \r
 109             private :\r
 110                 NSConsumerService();\r
 111                 ~NSConsumerService();\r
 112                 NSConsumerService(const NSConsumerService & ) = delete;\r
 113                 NSConsumerService &operator=(const NSConsumerService & ) = delete;\r
 114                 NSConsumerService(const NSConsumerService &&) = delete;\r
 115                 NSConsumerService &operator=(const NSConsumerService && ) = delete;\r
 116 \r
 117         };\r
 118     }\r
 119 }\r
 120 \r
 121 #endif //_NS_CONSUMER_SERVICE_H_\r