RDK Documentation (Open Sourced RDK Components)
Device_WiFi_X_RDKCENTRAL_COM_ClientRoaming.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 Device_WiFi_X_RDKCENTRAL_COM_ClientRoaming.h
22  *
23  * @brief TR-069 Device.WiFi.Radio object Public API.
24  *
25  * Description of Device_WiFi_X_RDKCENTRAL_COM_ClientRoaming module.
26  *
27  *
28  * @par Document
29  * Document reference.
30  *
31  *
32  * @par Open Issues (in no particular order)
33  * -# Issue 1
34  * -# Issue 2
35  *
36  *
37  * @par Assumptions
38  * -# Assumption
39  * -# Assumption
40  *
41  *
42  * @par Abbreviations
43  * - ACK: Acknowledge.
44  * - BE: Big-Endian.
45  * - cb: Callback function (suffix).
46  * - config: Configuration.
47  * - desc: Descriptor.
48  * - dword: Double word quantity, i.e., four bytes or 32 bits in size.
49  * - intfc: Interface.
50  * - LE: Little-Endian.
51  * - LS: Least Significant.
52  * - MBZ: Must be zero.
53  * - MS: Most Significant.
54  * - _t: Type (suffix).
55  * - word: Two byte quantity, i.e. 16 bits in size.
56  * - xfer: Transfer.
57  *
58  *
59  * @par Implementation Notes
60  * -# Note
61  * -# Note
62  *
63  */
64 
65 
66 
67 /**
68  * @defgroup tr69hostif
69  * @{
70  * @defgroup hostif
71  * @{
72  **/
73 
74 
75 #ifndef HOSTIF_DEVICE_WIFI_X_RDKCENTRAL_COM_CLIENTROAMING_H_
76 #define HOSTIF_DEVICE_WIFI_X_RDKCENTRAL_COM_CLIENTROAMING_H_
77 
78 #include "hostIf_main.h"
79 #include "hostIf_utils.h"
80 #include "hostIf_tr69ReqHandler.h"
81 #include "hostIf_updateHandler.h"
82 #include "Device_WiFi.h"
83 
84 
85 /*****************************************************************************
86  * TR069-SPECIFIC INCLUDE FILES
87  *****************************************************************************/
88 
89 /** @defgroup TR_069_DEVICE_WIFI_X_RDKCENTRAL_COM_CLIENTROAMING API TR-069 Device.WiFi.X_RDKCENTRAL-COM_ClientRoaming object API.
90  * @ingroup TR_069_DEVICE_WIFI_RDKCENTRAL_COM_CLIENTROAMING
91  *
92  * The Device.WiFi.X_RDKCENTRAL-COM_ClientRoaming object table. This object models an 802.11 wireless radio
93  * on a device (a stackable interface object as described in [Section 4.2/TR-181i2])..
94  *
95  *
96  * @{
97  */
98 #ifdef WIFI_CLIENT_ROAMING
99 class hostIf_WiFi_Xrdk_ClientRoaming {
100 
101  static GHashTable *ifHash;
102 
103  int dev_id;
104  hostIf_WiFi_Xrdk_ClientRoaming(int dev_id);
105  ~hostIf_WiFi_Xrdk_ClientRoaming() {};
106  int checkWifiClientRoamingropsFetch();
107 
108 public:
109  static class hostIf_WiFi_Xrdk_ClientRoaming *getInstance(int dev_id);
110  static void closeInstance(hostIf_WiFi_Xrdk_ClientRoaming *);
111  static void closeAllInstances();
112 
113  bool roamingEnable;
114  bool roamingConfigEnable;
115  int preassnProbeRetryCnt;
116  int preassnBestThreshold;
117  int preassnBestDelta;
118  int postAssnLevelDeltaConnected;
119  int postAssnLevelDeltaDisconnected;
120  int postAssnSelfSteerThreshold;
121  int postAssnSelfSteerTimeframe;
122  int postAssnSelfSteerBeaconsMissedTime;
123  int postAssnAPcontrolThresholdLevel;
124  int postAssnAPcontrolTimeframe;
125  int postAssnBackOffTime;
126  bool postAssnSelfSteerOverrideEnable;
127  bool roaming80211kvrEnable;
128 
129  /**
130  * @brief Enables or disables the Client Romaing
131  *
132  * This function provides to true/false value based on the
133  * Device.WiFi.X_RDKCENTRAL-COM_ClientRoaming.Enable
134  *
135  */
136  int get_Device_WiFi_X_Rdkcentral_clientRoaming_Enable(HOSTIF_MsgData_t *stMsgData);
137 
138  /**
139  * @brief set Enables/disables the Client Roaming
140  *
141  * This function set to true/false to 'Device.WiFi.X_RDKCENTRAL-COM_ClientRoaming.Enable' parameter.
142  *
143  */
144  int set_Device_WiFi_X_Rdkcentral_clientRoaming_Enable(HOSTIF_MsgData_t *stMsgData);
145 
146  /**
147  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_ProbeRetryCnt
148  *
149  *
150  */
151  int get_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_ProbeRetryCnt(HOSTIF_MsgData_t *stMsgData);
152 
153  /**
154  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_ProbeRetryCnt
155  *
156  *
157  */
158  int set_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_ProbeRetryCnt(HOSTIF_MsgData_t *stMsgData);
159 
160  /**
161  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_BestThresholdLevel
162  *
163  *
164  */
165  int get_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_BestThresholdLevel(HOSTIF_MsgData_t *stMsgData);
166 
167  /**
168  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_BestThresholdLevel
169  *
170  *
171  */
172 
173  int set_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_BestThresholdLevel(HOSTIF_MsgData_t *stMsgData);
174  /**
175  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_BestDeltaLevel
176  *
177  *
178  */
179  int get_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_BestDeltaLevel(HOSTIF_MsgData_t *stMsgData);
180 
181  /**
182  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_BestDeltaLevel
183  *
184  *
185  */
186  int set_Device_WiFi_X_Rdkcentral_clientRoaming_PreAssn_BestDeltaLevel(HOSTIF_MsgData_t *stMsgData);
187 
188  /**
189  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_SelfSteerOverride
190  *
191  *
192  */
193  int get_Device_WiFi_X_Rdkcentral_clientRoaming_SelfSteerOverride(HOSTIF_MsgData_t *stMsgData);
194  /**
195  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_SelfSteerOverride
196  *
197  *
198  */
199  int set_Device_WiFi_X_Rdkcentral_clientRoaming_SelfSteerOverride(HOSTIF_MsgData_t *stMsgData);
200  /**
201  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_BestDeltaLevelConnected
202  *
203  *
204  */
205  int get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_BestDeltaLevelConnected(HOSTIF_MsgData_t *stMsgData);
206  /**
207  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_BestDeltaLevelConnected
208  *
209  *
210  */
211  int set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_BestDeltaLevelConnected(HOSTIF_MsgData_t *stMsgData);
212  /**
213  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_BestDeltaLevelDisconnected
214  *
215  *
216  */
217  int get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_BestDeltaLevelDisconnected(HOSTIF_MsgData_t *stMsgData);
218  /**
219  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_BestDeltaLevelDisconnected
220  *
221  *
222  */
223  int set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_BestDeltaLevelDisconnected(HOSTIF_MsgData_t *stMsgData);
224 
225  /**
226  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerThreshold
227  *
228  *
229  */
230  int get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerThreshold(HOSTIF_MsgData_t *stMsgData);
231  /**
232  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerThreshold
233  *
234  *
235  */
236  int set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerThreshold(HOSTIF_MsgData_t *stMsgData);
237  /**
238  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerTimeframe
239  *
240  *
241  */
242  int get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerTimeframe(HOSTIF_MsgData_t *stMsgData);
243  /**
244  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerTimeframe
245  *
246  *
247  */
248  int set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerTimeframe(HOSTIF_MsgData_t *stMsgData);
249  /**
250  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerBeaconsMissedTime
251  *
252  *
253  */
254  //int get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerBeaconsMissedTime(HOSTIF_MsgData_t *stMsgData);
255  /**
256  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerBeaconsMissedTime
257  *
258  *
259  */
260  //int set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_SelfSteerBeaconsMissedTime(HOSTIF_MsgData_t *stMsgData);
261  /**
262  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_APcontrolThresholdLevel
263  *
264  *
265  */
266  int get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_APcontrolThresholdLevel(HOSTIF_MsgData_t *stMsgData);
267  /**
268  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_APcontrolThresholdLevel
269  *
270  *
271  */
272  int set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_APcontrolThresholdLevel(HOSTIF_MsgData_t *stMsgData);
273  /**
274  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_APcontrolTimeframe
275  *
276  *
277  */
278  int get_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_APcontrolTimeframe(HOSTIF_MsgData_t *stMsgData);
279  /**
280  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_APcontrolTimeframe
281  *
282  *
283  */
284  int set_Device_WiFi_X_Rdkcentral_clientRoaming_PostAssn_APcontrolTimeframe(HOSTIF_MsgData_t *stMsgData);
285  /**
286  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_postAssnBackOffTime
287  *
288  *
289  */
290  int get_Device_WiFi_X_Rdkcentral_clientRoaming_postAssnBackOffTime(HOSTIF_MsgData_t *stMsgData);
291  /**
292  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_postAssnBackOffTime
293  *
294  *
295  */
296  int set_Device_WiFi_X_Rdkcentral_clientRoaming_postAssnBackOffTime(HOSTIF_MsgData_t *stMsgData);
297  /**
298  * @brief get_Device_WiFi_X_Rdkcentral_clientRoaming_80211kvrEnable
299  *
300  *
301  */
302  int get_Device_WiFi_X_Rdkcentral_clientRoaming_80211kvrEnable(HOSTIF_MsgData_t *stMsgData);
303  /**
304  * @brief set_Device_WiFi_X_Rdkcentral_clientRoaming_80211kvrEnable
305  *
306  *
307  */
308  int set_Device_WiFi_X_Rdkcentral_clientRoaming_80211kvrEnable(HOSTIF_MsgData_t *stMsgData);
309 };
310 
311 /* End of TR069_HOSTIF_DEVICE_WIFI_X_RDKCENTRAL_COM_CLIENTROAMING_H_ doxygen group */
312 /**
313  * @}
314  */
315 #endif // WIFI_CLIENT_ROAMING
316 #endif /* HOSTIF_DEVICE_WIFI_X_RDKCENTRAL_COM_CLIENTROAMING */
317 
318 
319 /** @} */
320 /** @} */
Device_WiFi.h
_HostIf_MsgData_t
Definition: hostIf_tr69ReqHandler.h:170
hostIf_main.h
hostIf_main API.