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