1 //******************************************************************
\r
3 // Copyright 2016 Samsung Electronics All Rights Reserved.
\r
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
\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
11 // http://www.apache.org/licenses/LICENSE-2.0
\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
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
\r
24 * This file provides C++ Wrapper APIs of Notification Service for Provider.
\r
27 #ifndef _NS_PROVIDER_SERVICE_H_
\r
28 #define _NS_PROVIDER_SERVICE_H_
\r
31 #include "NSConsumer.h"
\r
32 #include "NSSyncInfo.h"
\r
33 #include "NSMessage.h"
\r
34 #include "NSUtils.h"
\r
35 #include "NSTopicsList.h"
\r
42 * @class NSProviderService
\r
43 * @brief This class provides a set of C++APIs for Notification Provider.
\r
45 class NSProviderService
\r
50 * Provider uses this callback function to receive subscription request of consumer
\r
51 * @param[in] consumer Consumer who subscribes the resource
\r
53 typedef void (*ConsumerSubscribedCallback)(NSConsumer *);
\r
56 * Provider use this callback function to receive the status of the message
\r
58 * @param[in] sync Synchronization information of the notification message
\r
60 typedef void (*MessageSynchronizedCallback)(NSSyncInfo *);
\r
64 * @struct ProviderConfig
\r
65 * @brief Provider sets this following configuration for registering callbacks and configs
\r
66 * Set the subControllability, for notification servcie refering to following
\r
67 * if subControllability, is true, provider decides to allow or deny for all the subscribing consumers.
\r
68 * Otherwise(subControllability, is false) consumer decides to request subscription to discovered providers.
\r
72 /** m_subscribeRequestCb - ConsumerSubscribedCallback callback listener.*/
\r
73 ConsumerSubscribedCallback m_subscribeRequestCb;
\r
74 /** m_syncInfoCb - MessageSynchronizedCallback callback listener.*/
\r
75 MessageSynchronizedCallback m_syncInfoCb;
\r
77 /** subControllability - for setting the subscription controllability for Consumer */
\r
78 bool subControllability;
\r
79 /** userInfo - user defined information */
\r
80 std::string userInfo;
\r
84 * API for starting the NS Provider
\r
86 * @return NSProviderService Pointer to singleton instance created
\r
88 static NSProviderService *getInstance();
\r
91 * Initialize notification service for provider
\r
92 * @param[in] config ProviderConfig Callback function pointers to onConsumerSubscribed,
\r
93 * and onMessageSynchronized function listeners
\r
94 * @return :: result code of Provider Service
\r
96 NSResult start(ProviderConfig config);
\r
99 * Terminate notification service for provider
\r
100 * @return :: result code of Provider Service
\r
105 * Request to publish resource to cloud server
\r
106 * @param[in] serverAddress combined with IP address and port number using delimiter :
\r
107 * @return result code of Provider Service
\r
109 NSResult enableRemoteService(const std::string &serverAddress);
\r
112 * Request to cancel remote service using cloud server
\r
113 * @param[in] serverAddress combined with IP address and port number using delimiter :
\r
114 * @return result code of Provider Service
\r
116 NSResult disableRemoteService(const std::string &serverAddress);
\r
119 * Send notification message to all subscribers
\r
120 * @param[in] msg Notification message including id, title, contentText
\r
121 * @return :: result code of Provider Service
\r
123 NSResult sendMessage(NSMessage *msg);
\r
127 * Send read-check to provider in order to synchronize notification status with other consumers
\r
128 * @param[in] messageId Notification message to synchronize the status
\r
129 * @param[in] type NotificationSyncType of the SyncInfo message
\r
131 void sendSyncInfo(uint64_t messageId, NSSyncInfo::NSSyncType type);
\r
134 * Initialize NSMessage class, service sets message id and provider(device) id
\r
135 * @return NSMessage *
\r
137 NSMessage *createMessage();
\r
140 * Add topic to topic list which is located in provider service storage
\r
141 * @param[in] topicName Topic name to add
\r
142 * @return :: OK or result code of NSResult
\r
144 NSResult registerTopic(const std::string &topicName);
\r
147 * Delete topic from topic list
\r
148 * @param[in] topicName Topic name to delete
\r
149 * @return :: OK or result code of NSResult
\r
151 NSResult unregisterTopic(const std::string &topicName);
\r
154 * Request topics list already registered by provider user
\r
155 * @return :: Topic list
\r
157 NSTopicsList *getRegisteredTopicList();
\r
160 * get Provider config values
\r
161 * @return ProviderConfig callbaks set
\r
163 ProviderConfig getProviderConfig();
\r
166 * request to get NSConsumer pointer
\r
167 * @param id -id as string
\r
169 * @return pointer to NSConsumer
\r
171 NSConsumer *getConsumer(const std::string &id);
\r
174 * get list of Consumers accepted.
\r
175 * @return m_acceptedConsumers -list of accepted Consumers
\r
177 std::list<NSConsumer *> &getAcceptedConsumers();
\r
180 ProviderConfig m_config;
\r
181 std::list<NSConsumer *> m_acceptedConsumers;
\r
184 NSProviderService()
\r
186 m_config.m_subscribeRequestCb = NULL;
\r
187 m_config.m_syncInfoCb = NULL;
\r
189 ~NSProviderService();
\r
190 NSProviderService(const NSProviderService &) = delete;
\r
191 NSProviderService &operator=(const NSProviderService &) = delete;
\r
192 NSProviderService(const NSProviderService &&) = delete;
\r
193 NSProviderService &operator=(const NSProviderService && ) = delete;
\r
195 ::NSMessage *getNSMessage(NSMessage *msg);
\r
199 #endif /* _NS_PROVIDER_SERVICE_H_ */
\r