RDK Documentation (Open Sourced RDK Components)
hostIf_WiFi_ReqHandler.h
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's Licenses.txt file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2016 RDK Management
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  * @file hostIf_WiFi_ReqHandler.h
22  * @brief The header file provides HostIf WiFi request handler information APIs.
23  */
24 
25 /**
26  * @defgroup TR-069HOSTIF_WIFI_REQHANDLER_CLASSES WiFi RequestHandler Public Classes
27  * Describe the details about classes used in TR-069 WiFi request handler.
28  * @ingroup TR-069HOSTIF_DEVICECLIENT_HANDLER
29  */
30 
31 /**
32  * It allows moca client applications to communicate by sending Get operation
33  * from Time library.
34  */
35 
36 
37 /**
38 * @defgroup tr69hostif
39 * @{
40 * @defgroup hostif
41 * @{
42 **/
43 
44 
45 #ifndef HOSTIF_WIFI_REQHANDLER_H_
46 #define HOSTIF_WIFI_REQHANDLER_H_
47 
48 #ifdef USE_WIFI_PROFILE
49 
50 #include "hostIf_msgHandler.h"
51 #include "hostIf_updateHandler.h"
52 
53 
54 #define DEVICE_WIFI_SSID_PROFILE "Device.WiFi.SSID."
55 #define DEVICE_WIFI_RADIO_PROFILE "Device.WiFi.Radio."
56 #define DEVICE_WIFI_ENDPOINT_PROFILE "Device.WiFi.EndPoint."
57 
58 /**
59  * @brief This class provides the interface for getting WiFi request handler information.
60  * @ingroup TR-069HOSTIF_WIFI_REQHANDLER_CLASSES
61  */
62 class WiFiReqHandler : public msgHandler
63 {
64 //private:
65  WiFiReqHandler() {};
66  ~WiFiReqHandler() {};
67  static class WiFiReqHandler *pInstance;
68  static updateCallback mUpdateCallback;
69 private:
70  static int savedSSIDNumberOfEntries;
71  static int savedRadioNumberOfEntries;
72  static int savedEndPointNumberOfEntries;
73 
74 public:
75  virtual bool init();
76  virtual bool unInit();
77  virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData);
78  virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData);
79  virtual int handleGetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
80  virtual int handleSetAttributesMsg(HOSTIF_MsgData_t *stMsgData);
81  static msgHandler* getInstance();
82  static void registerUpdateCallback(updateCallback cb);
83  static void checkForUpdates();
84  static void reset();
85 };
86 
87 #endif /* #ifdef USE_WIFI_PROFILE*/
88 
89 #endif /* HOSTIF_WIFI_REQHANDLER_H_ */
90 /* End of HOSTIF_WIFI_REQHANDLER_H_ doxygen group */
91 /**
92  * @}
93  */
94 
95 
96 /** @} */
97 /** @} */
msgHandler::init
virtual bool init()=0
This is a pure virtual function used for initialization. Currently not implemented.
_HostIf_MsgData_t
Definition: hostIf_tr69ReqHandler.h:170
msgHandler::handleGetMsg
virtual int handleGetMsg(HOSTIF_MsgData_t *stMsgData)=0
This is a pure virtual function used to handle the get message request. Currently not implemented.
msgHandler
Definition: hostIf_msgHandler.h:103
hostIf_msgHandler.h
The header file provides HostIf message handler information APIs.
msgHandler::unInit
virtual bool unInit()=0
This is a pure virtual function used for un initialization. Currently not implemented.
msgHandler::handleSetMsg
virtual int handleSetMsg(HOSTIF_MsgData_t *stMsgData)=0
This is a pure virtual function used to handle the set message request. Currently not implemented.