RDK Documentation (Open Sourced RDK Components)
Device_WiFi_EndPoint_WPS.h
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  * @defgroup TR69_HOSTIF_WIFI_ENDPOINT_WPS TR-069 Object (Device.WiFi.EndPoint.{i}.WPS.) Public APIs
22  * This object contains parameters related to Wi-Fi Protected Setup [WPSv1.0] for this end point.
23  * @ingroup TR69_HOSTIF_WIFI
24  */
25 
26 
27 /**
28 * @defgroup tr69hostif
29 * @{
30 * @defgroup hostif
31 * @{
32 **/
33 
34 
35 #ifndef DEVICE_WIFI_ENDPOINT_WPS_H_
36 #define DEVICE_WIFI_ENDPOINT_WPS_H_
37 
38 #include "hostIf_main.h"
39 #include "hostIf_utils.h"
40 #include "hostIf_tr69ReqHandler.h"
41 #include "hostIf_updateHandler.h"
42 #include "Device_WiFi_EndPoint.h"
43 
45 
46  static GHashTable *ifHash;
47 // GMutex* m_mutex = NULL;
48  int dev_id = 0; //CID:102980 - UNINIT_CTOR
49  hostIf_WiFi_EndPoint_WPS(int dev_id);
51 
52 public:
53  static class hostIf_WiFi_EndPoint_WPS *getInstance(int dev_id);
54  static GList* getAllInstances();
55  static void closeInstance(hostIf_WiFi_EndPoint_WPS *);
56  static void closeAllInstances();
57 
58  bool Enable;
59  char ConfigMethodsSupported[64];
60  char ConfigMethodsEnabled[64];
61 
62  /**
63  * @ingroup TR69_HOSTIF_WIFI_ENDPOINT_WPS
64  * @{
65  */
66  /**
67  * @brief Enables or disables WPS functionality for this end point.
68  *
69  * @param[out] stMsgData TR-069 Host interface message request.
70  *
71  * @return Returns 0 on success, otherwise will return the appropriate error code.
72  */
74 
75  /**
76  * @brief Get the comma-separated list of strings, containing the WPS configuration methods
77  * supported by the device.
78  *
79  * Each list item is an enumeration of:
80  * - USBFlashDrive
81  * - Ethernet
82  * - ExternalNFCToken
83  * - IntegratedNFCToken
84  * - NFCInterface
85  * - PushButton
86  * - PIN
87  * This parameter corresponds directly to the "Config Methods" attribute of the WPS specification [WPSv1.0].
88  *
89  * @param[out] stMsgData TR-069 Host interface message request.
90  *
91  * @return Returns 0 on success, otherwise will return the appropriate error code.
92  */
94 
95  /**
96  * @brief Check the WPS configuration methods enabled on the device.
97  *
98  * Comma-separated list of strings. Each list item MUST be a member of the list reported
99  * by the ConfigMethodsSupported parameter.
100  *
101  * @param[out] stMsgData TR-069 Host interface message request.
102  *
103  * @return Returns 0 on success, otherwise will return the appropriate error code.
104  */
106 
107  /** @} */ //End of Doxygen Tag TR69_HOSTIF_WIFI_ENDPOINT_WPS
108 };
109 
110 
111 #endif /* DEVICE_WIFI_ENDPOINT_WPS_H_ */
112 
113 
114 /** @} */
115 /** @} */
hostIf_WiFi_EndPoint_WPS::get_Device_WiFi_EndPoint_WPS_Enable
int get_Device_WiFi_EndPoint_WPS_Enable(HOSTIF_MsgData_t *stMsgData)
Enables or disables WPS functionality for this end point.
_HostIf_MsgData_t
Definition: hostIf_tr69ReqHandler.h:170
hostIf_main.h
hostIf_main API.
hostIf_WiFi_EndPoint_WPS
Definition: Device_WiFi_EndPoint_WPS.h:44
hostIf_WiFi_EndPoint_WPS::get_Device_WiFi_EndPoint_WPS_ConfigMethodsSupported
int get_Device_WiFi_EndPoint_WPS_ConfigMethodsSupported(HOSTIF_MsgData_t *stMsgData)
Get the comma-separated list of strings, containing the WPS configuration methods supported by the de...
hostIf_WiFi_EndPoint_WPS::get_Device_WiFi_EndPoint_WPS_ConfigMethodsEnabled
int get_Device_WiFi_EndPoint_WPS_ConfigMethodsEnabled(HOSTIF_MsgData_t *stMsgData)
Check the WPS configuration methods enabled on the device.