• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# IHostapdInterface
2
3
4## 概述
5
6定义上层WLAN服务的接口。
7
8**起始版本：** 4.1
9
10**相关模块：**[Hostapd](_hostapd.md)
11
12
13## 汇总
14
15
16### Public 成员函数
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [StartAp](#startap) () | 打开AP  |
21| [StopAp](#stopap) () | 关闭AP  |
22| [EnableAp](#enableap) ([in] String ifName, [in] int id) | 启用AP  |
23| [DisableAp](#disableap) ([in] String ifName, [in] int id) | 禁用AP.  |
24| [SetApPasswd](#setappasswd) ([in] String ifName, [in] String pass, [in]int id) | 设置个人热点密码  |
25| [SetApName](#setapname) ([in] String ifName, [in] String name, [in] int id) | 设置个人热点名称  |
26| [SetApWpaValue](#setapwpavalue) ([in] String ifName, [in] int securityType, [in] int id) | 设置AP安全类型  |
27| [SetApBand](#setapband) ([in] String ifName, [in] int band, [in] int id) | 设置AP带宽  |
28| [SetAp80211n](#setap80211n) ([in] String ifName, [in] int value, [in] int id) | 设置AP需要支持的协议类型  |
29| [SetApWmm](#setapwmm) ([in] String ifName, [in] int value, [in] int id) | 设置AP WMM模式  |
30| [SetApChannel](#setapchannel) ([in] String ifName, [in] int channel, [in] int id) | 设置AP通道  |
31| [SetApMaxConn](#setapmaxconn) ([in] String ifName, [in] int maxConn, [in] int id) | 设置AP最大连接  |
32| [SetMacFilter](#setmacfilter) ([in] String ifName, [in] String mac, [in] int id) | 设置AP模式下的黑名单设置为禁止MAC地址连接  |
33| [DelMacFilter](#delmacfilter) ([in] String ifName, [in] String mac, [in] int id) | 在AP模式下设置的黑名单过滤，并删除来自黑名单中指定的MAC地址。  |
34| [GetStaInfos](#getstainfos) ([in] String ifName, [out] String buf, [in] int size, [in] int id) | 获取有关所有连接的STA的信息  |
35| [DisassociateSta](#disassociatesta) ([in] String ifName, [in] String mac, [in] int id) | 断开指定的STA连接  |
36| [RegisterEventCallback](#registereventcallback) ([in] [IHostapdCallback](interface_i_hostapd_callback.md) cbFunc, [in] String ifName) | 注册回调以侦听异步事件  |
37| [UnregisterEventCallback](#unregistereventcallback) ([in] [IHostapdCallback](interface_i_hostapd_callback.md) cbFunc, [in] String ifName) | 注销回调  |
38| [HostApdShellCmd](#hostapdshellcmd) ([in] String ifName, [in] String cmd) | 用于处理Hostapd的cmd命令  |
39
40
41## 成员函数说明
42
43
44### DelMacFilter()
45
46```
47IHostapdInterface::DelMacFilter ([in] String ifName, [in] String mac, [in] int id )
48```
49**描述**
50在AP模式下设置的黑名单过滤，并删除来自黑名单中指定的MAC地址。
51
52**起始版本：** 4.1
53
54**参数:**
55
56| 名称 | 描述 |
57| -------- | -------- |
58| ifName | 表示网卡名称  |
59| id | 表示热点id  |
60| mac | 表示黑名单中的MAC地址 |
61
62**返回：**
63
64返回值 如果操作成功，则返回0。
65
66返回值 如果操作失败，则为负值。
67
68
69### DisableAp()
70
71```
72IHostapdInterface::DisableAp ([in] String ifName, [in] int id )
73```
74**描述**
75禁用AP.
76
77**起始版本：** 4.1
78
79**参数:**
80
81| 名称 | 描述 |
82| -------- | -------- |
83| ifName | 表示网卡名称  |
84| id | 表示热点id |
85
86**返回：**
87
88返回值 如果操作成功，则返回0。
89
90返回值 如果操作失败，则为负值。
91
92
93### DisassociateSta()
94
95```
96IHostapdInterface::DisassociateSta ([in] String ifName, [in] String mac, [in] int id )
97```
98**描述**
99断开指定的STA连接
100
101**起始版本：** 4.1
102
103**参数:**
104
105| 名称 | 描述 |
106| -------- | -------- |
107| ifName | 表示网卡名称  |
108| id | 表示热点id  |
109| mac | 表示要断开的指定mac |
110
111**返回：**
112
113返回值 如果操作成功，则返回0。
114
115返回值 如果操作失败，则为负值。
116
117
118### EnableAp()
119
120```
121IHostapdInterface::EnableAp ([in] String ifName, [in] int id )
122```
123**描述**
124启用AP
125
126**起始版本：** 4.1
127
128**参数:**
129
130| 名称 | 描述 |
131| -------- | -------- |
132| ifName | 表示网卡名称  |
133| id | 表示热点id |
134
135**返回：**
136
137返回值 如果操作成功，则返回0。
138
139返回值 如果操作失败，则为负值。
140
141
142### GetStaInfos()
143
144```
145IHostapdInterface::GetStaInfos ([in] String ifName, [out] String buf, [in] int size, [in] int id )
146```
147**描述**
148获取有关所有连接的STA的信息
149
150**起始版本：** 4.1
151
152**参数:**
153
154| 名称 | 描述 |
155| -------- | -------- |
156| ifName | 表示网卡名称  |
157| id | 表示热点id  |
158| buf | 表示已连接STA数组信息  |
159| size | 表示获取已连接STA数组中，数组信息的大小。 |
160
161**返回：**
162
163返回值 如果操作成功，则返回0。
164
165返回值 如果操作失败，则为负值。
166
167
168### HostApdShellCmd()
169
170```
171IHostapdInterface::HostApdShellCmd ([in] String ifName, [in] String cmd )
172```
173**描述**
174用于处理Hostapd的cmd命令
175
176**起始版本：** 4.1
177
178**参数:**
179
180| 名称 | 描述 |
181| -------- | -------- |
182| ifName | 表示NIC名称  |
183| cmd | 表示来自WifiHal的HostApd命令 |
184
185**返回：**
186
187返回值 如果操作成功，则返回0。
188
189返回值 如果操作失败，则为负值。
190
191
192### RegisterEventCallback()
193
194```
195IHostapdInterface::RegisterEventCallback ([in] IHostapdCallback cbFunc, [in] String ifName )
196```
197**描述**
198注册回调以侦听异步事件
199
200**起始版本：** 4.1
201
202**参数:**
203
204| 名称 | 描述 |
205| -------- | -------- |
206| cbFunc | 表示要注册的回调  |
207| ifName | 表示NIC名称 |
208
209**返回：**
210
211返回值 如果操作成功，则返回0。
212
213返回值 如果操作失败，则为负值。
214
215
216### SetAp80211n()
217
218```
219IHostapdInterface::SetAp80211n ([in] String ifName, [in] int value, [in] int id )
220```
221**描述**
222设置AP需要支持的协议类型
223
224**起始版本：** 4.1
225
226**参数:**
227
228| 名称 | 描述 |
229| -------- | -------- |
230| ifName | 表示网卡名称  |
231| id | 表示热点id  |
232| value | 表示Hostapd配置值 |
233
234**返回：**
235
236返回值 如果操作成功，则返回0。
237
238返回值 如果操作失败，则为负值。
239
240
241### SetApBand()
242
243```
244IHostapdInterface::SetApBand ([in] String ifName, [in] int band, [in] int id )
245```
246**描述**
247设置AP带宽
248
249**起始版本：** 4.1
250
251**参数:**
252
253| 名称 | 描述 |
254| -------- | -------- |
255| ifName | 表示网卡名称  |
256| id | 表示热点id  |
257| band | 表示SAP带宽 |
258
259**返回：**
260
261返回值 如果操作成功，则返回0。
262
263返回值 如果操作失败，则为负值。
264
265
266### SetApChannel()
267
268```
269IHostapdInterface::SetApChannel ([in] String ifName, [in] int channel, [in] int id )
270```
271**描述**
272设置AP通道
273
274**起始版本：** 4.1
275
276**参数:**
277
278| 名称 | 描述 |
279| -------- | -------- |
280| ifName | 表示网卡名称  |
281| id | 表示热点id  |
282| channel | 表示AP通道 |
283
284**返回：**
285
286返回值 如果操作成功，则返回0。
287
288返回值 如果操作失败，则为负值。
289
290
291### SetApMaxConn()
292
293```
294IHostapdInterface::SetApMaxConn ([in] String ifName, [in] int maxConn, [in] int id )
295```
296**描述**
297设置AP最大连接
298
299**起始版本：** 4.1
300
301**参数:**
302
303| 名称 | 描述 |
304| -------- | -------- |
305| ifName | 表示网卡名称  |
306| id | 表示热点id  |
307| maxConn | 表示设置连接设备的最大数量 |
308
309**返回：**
310
311返回值 如果操作成功，则返回0。
312
313返回值 如果操作失败，则为负值。
314
315
316### SetApName()
317
318```
319IHostapdInterface::SetApName ([in] String ifName, [in] String name, [in] int id )
320```
321**描述**
322设置个人热点名称
323
324**起始版本：** 4.1
325
326**参数:**
327
328| 名称 | 描述 |
329| -------- | -------- |
330| ifName | 表示网卡名称  |
331| id | 表示热点id  |
332| name | 热点名称 |
333
334**返回：**
335
336返回值 如果操作成功，则返回0。
337
338返回值 如果操作失败，则为负值。
339
340
341### SetApPasswd()
342
343```
344IHostapdInterface::SetApPasswd ([in] String ifName, [in] String pass, [in] int id )
345```
346**描述**
347设置个人热点密码
348
349**起始版本：** 4.1
350
351**参数:**
352
353| 名称 | 描述 |
354| -------- | -------- |
355| ifName | 表示网卡名称  |
356| id | 表示热点id  |
357| pass | 密码 |
358
359**返回：**
360
361返回值 如果操作成功，则返回0。
362
363返回值 如果操作失败，则为负值。
364
365
366### SetApWmm()
367
368```
369IHostapdInterface::SetApWmm ([in] String ifName, [in] int value, [in] int id )
370```
371**描述**
372设置AP WMM模式
373
374**起始版本：** 4.1
375
376**参数:**
377
378| 名称 | 描述 |
379| -------- | -------- |
380| ifName | 表示网卡名称  |
381| id | 表示热点id  |
382| value | 表示启用或禁用Wmm |
383
384**返回：**
385
386返回值 如果操作成功，则返回0。
387
388返回值 如果操作失败，则为负值。
389
390
391### SetApWpaValue()
392
393```
394IHostapdInterface::SetApWpaValue ([in] String ifName, [in] int securityType, [in] int id )
395```
396**描述**
397设置AP安全类型
398
399**起始版本：** 4.1
400
401**参数:**
402
403| 名称 | 描述 |
404| -------- | -------- |
405| ifName | 表示网卡名称  |
406| id | 表示热点id  |
407| securityType | 表示SAP安全类型，例如：wpa/wpa_psk等。 |
408
409**返回：**
410
411返回值 如果操作成功，则返回0。
412
413返回值 如果操作失败，则为负值。
414
415
416### SetMacFilter()
417
418```
419IHostapdInterface::SetMacFilter ([in] String ifName, [in] String mac, [in] int id )
420```
421**描述**
422设置AP模式下的黑名单设置为禁止MAC地址连接
423
424**起始版本：** 4.1
425
426**参数:**
427
428| 名称 | 描述 |
429| -------- | -------- |
430| ifName | 表示网卡名称  |
431| id | 表示热点id  |
432| mac | 表示被阻止的MAC地址 |
433
434**返回：**
435
436返回值 如果操作成功，则返回0。
437
438返回值 如果操作失败，则为负值。
439
440
441### StartAp()
442
443```
444IHostapdInterface::StartAp ()
445```
446**描述**
447打开AP
448
449**起始版本：** 4.1
450
451**参数:**
452
453| 名称 | 描述 |
454| -------- | -------- |
455| ifName | 表示网卡名称  |
456| id | 表示热点id |
457
458**返回：**
459
460返回值 如果操作成功，则返回0。
461
462返回值 如果操作失败，则为负值。
463
464
465### StopAp()
466
467```
468IHostapdInterface::StopAp ()
469```
470**描述**
471关闭AP
472
473**起始版本：** 4.1
474
475**参数:**
476
477| 名称 | 描述 |
478| -------- | -------- |
479| ifName | 表示网卡名称  |
480| id | 表示热点id |
481
482**返回：**
483
484返回值 如果操作成功，则返回0。
485
486返回值 如果操作失败，则为负值。
487
488
489### UnregisterEventCallback()
490
491```
492IHostapdInterface::UnregisterEventCallback ([in] IHostapdCallback cbFunc, [in] String ifName )
493```
494**描述**
495注销回调
496
497**起始版本：** 4.1
498
499**参数:**
500
501| 名称 | 描述 |
502| -------- | -------- |
503| cbFunc | 表示要注销的回调  |
504| ifName | 表示NIC名称 |
505
506**返回：**
507
508返回值 如果操作成功，则返回0。
509
510返回值 如果操作失败，则为负值。
511