Wi-Fi access point stateFULL_MAC_API
WFM API messages applicable for an interface in AP mode.
Data Structures | |
| struct | WfmHiUpdateApReq_t |
| Request message for updating parameters of the started Wi-Fi network. | |
| struct | WfmHiUpdateApCnf_t |
| Confirmation message for WfmHiUpdateApReq_t. | |
| struct | WfmHiStopApCnf_t |
| Confirmation message for WfmHiStopApReq_t. | |
| struct | WfmHiApClientConnectedInd_t |
| Indication message used to signal a connected station. | |
| struct | WfmHiApClientRejectedInd_t |
| Indication message used to signal a rejected connection attempt from a station. | |
| struct | WfmHiDisconnectApClientReq_t |
| Request message for disconnecting a client from the started Wi-Fi network. | |
| struct | WfmHiDisconnectApClientCnf_t |
| Confirmation message for WfmHiDisconnectApClientReq_t. | |
| struct | WfmHiApClientDisconnectedInd_t |
| Indication message used to signal a disconnected station. | |
| struct | WfmHiSendFrameReq_t |
| Request message for sending a packet to the network. | |
| struct | WfmHiSendFrameCnf_t |
| Confirmation message for WfmHiSendFrameReq_t. | |
| struct | WfmHiReceivedInd_t |
| Indication message used to signal a received packet. | |
| struct | WfmHiAddMulticastAddrReq_t |
| Request message for adding a multicast address to the multicast filter whitelist. | |
| struct | WfmHiAddMulticastAddrCnf_t |
| Confirmation message for WfmHiAddMulticastAddrReq_t. | |
| struct | WfmHiRemoveMulticastAddrReq_t |
| Request message for removing a multicast address from the multicast filter whitelist. | |
| struct | WfmHiRemoveMulticastAddrCnf_t |
| Confirmation message for WfmHiRemoveMulticastAddrReq_t. | |
| struct | WfmHiSetMaxApClientCountReq_t |
| Request message for setting the maximum number of connected clients. | |
| struct | WfmHiSetMaxApClientCountCnf_t |
| Confirmation message for WfmHiSetMaxApClientCountReq_t. | |
| struct | WfmHiSetMaxApClientInactivityReq_t |
| Request message for setting the maximum number of connected clients. | |
| struct | WfmHiSetMaxApClientInactivityCnf_t |
| Confirmation message for WfmHiSetMaxApClientInactivityReq_t. | |
| struct | WfmHiStopApReq_t |
| Request message for stopping the started Wi-Fi network. | |
| struct | WfmHiStopApInd_t |
| Indication message used to signal the completion of a stop operation. | |
Detailed Description
WFM API messages applicable for an interface in AP mode.
Data Structure Documentation
◆ WfmHiUpdateApReq_t
| struct WfmHiUpdateApReq_t |
Request message for updating parameters of the started Wi-Fi network.
The host can use this request to update parameters of the started Wi-Fi network.
Definition at line 1182 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiUpdateApReqBody_t | Body | Request message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiUpdateApCnf_t
| struct WfmHiUpdateApCnf_t |
Confirmation message for WfmHiUpdateApReq_t.
Definition at line 1206 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiUpdateApCnfBody_t | Body | Confirmation message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiStopApCnf_t
| struct WfmHiStopApCnf_t |
Confirmation message for WfmHiStopApReq_t.
Definition at line 1239 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiStopApCnfBody_t | Body | Confirmation message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiApClientConnectedInd_t
| struct WfmHiApClientConnectedInd_t |
Indication message used to signal a connected station.
The device will send this indication to signal a station has connected to the started network.
Definition at line 1272 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiApClientConnectedIndBody_t | Body | Indication message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiApClientRejectedInd_t
| struct WfmHiApClientRejectedInd_t |
Indication message used to signal a rejected connection attempt from a station.
The device will send this indication to signal a station has attempted connection to the started network and was rejected by the device.
Definition at line 1303 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiApClientRejectedIndBody_t | Body | Indication message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiDisconnectApClientReq_t
| struct WfmHiDisconnectApClientReq_t |
Request message for disconnecting a client from the started Wi-Fi network.
The host can use this request to disconnect a client from the started Wi-Fi network.
Definition at line 1325 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiDisconnectApClientReqBody_t | Body | Request message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiDisconnectApClientCnf_t
| struct WfmHiDisconnectApClientCnf_t |
Confirmation message for WfmHiDisconnectApClientReq_t.
Definition at line 1349 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiDisconnectApClientCnfBody_t | Body | Confirmation message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiApClientDisconnectedInd_t
| struct WfmHiApClientDisconnectedInd_t |
Indication message used to signal a disconnected station.
The device will send this indication to signal a station has left the started network.
Definition at line 1378 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiApClientDisconnectedIndBody_t | Body | Indication message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSendFrameReq_t
| struct WfmHiSendFrameReq_t |
Request message for sending a packet to the network.
The host can use this request to send a packet to the network.
Definition at line 1424 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiSendFrameReqBody_t | Body | Request message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSendFrameCnf_t
| struct WfmHiSendFrameCnf_t |
Confirmation message for WfmHiSendFrameReq_t.
Definition at line 1458 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiSendFrameCnfBody_t | Body | Confirmation message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiReceivedInd_t
| struct WfmHiReceivedInd_t |
Indication message used to signal a received packet.
The device will send this indication to signal a packet has been received.
Definition at line 1503 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiReceivedIndBody_t | Body | Indication message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiAddMulticastAddrReq_t
| struct WfmHiAddMulticastAddrReq_t |
Request message for adding a multicast address to the multicast filter whitelist.
The host can use this request to add a multicast address to the multicast filter whitelist. When the first address is added the whitelist, the device will discard all multicast frames whose destination address does not match any of the addresses on the list. The default state is to allow all multicast addresses.
See Filtering for further details.
Definition at line 1885 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiAddMulticastAddrReqBody_t | Body | Request message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiAddMulticastAddrCnf_t
| struct WfmHiAddMulticastAddrCnf_t |
Confirmation message for WfmHiAddMulticastAddrReq_t.
Definition at line 1910 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiAddMulticastAddrCnfBody_t | Body | Confirmation message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiRemoveMulticastAddrReq_t
| struct WfmHiRemoveMulticastAddrReq_t |
Request message for removing a multicast address from the multicast filter whitelist.
The host can use this request to remove a multicast address from the multicast filter whitelist.
Definition at line 1936 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiRemoveMulticastAddrReqBody_t | Body | Request message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiRemoveMulticastAddrCnf_t
| struct WfmHiRemoveMulticastAddrCnf_t |
Confirmation message for WfmHiRemoveMulticastAddrReq_t.
Definition at line 1961 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiRemoveMulticastAddrCnfBody_t | Body | Confirmation message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetMaxApClientCountReq_t
| struct WfmHiSetMaxApClientCountReq_t |
Request message for setting the maximum number of connected clients.
The host can use this request to limit the number of stations that can connect the started Wi-Fi network.
Definition at line 1986 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiSetMaxApClientCountReqBody_t | Body | Request message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetMaxApClientCountCnf_t
| struct WfmHiSetMaxApClientCountCnf_t |
Confirmation message for WfmHiSetMaxApClientCountReq_t.
Definition at line 2010 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiSetMaxApClientCountCnfBody_t | Body | Confirmation message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetMaxApClientInactivityReq_t
| struct WfmHiSetMaxApClientInactivityReq_t |
Request message for setting the maximum number of connected clients.
The host can use this request to limit the number of stations that can connect the started Wi-Fi network.
Definition at line 2035 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiSetMaxApClientInactivityReqBody_t | Body | Request message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetMaxApClientInactivityCnf_t
| struct WfmHiSetMaxApClientInactivityCnf_t |
Confirmation message for WfmHiSetMaxApClientInactivityReq_t.
Definition at line 2059 of file wfm_cmd_api.h.
| Data Fields | ||
|---|---|---|
| WfmHiSetMaxApClientInactivityCnfBody_t | Body | Confirmation message body. |
| HiMsgHdr_t | Header | Common message header. |
◆ WfmHiStopApReq_t
| struct WfmHiStopApReq_t |
Request message for stopping the started Wi-Fi network.
The host can use this request to stop the started Wi-Fi network.
Successful stop request moves the interface to Idle state.
◆ WfmHiStopApInd_t
| struct WfmHiStopApInd_t |
Indication message used to signal the completion of a stop operation.
The device will send this indication to signal the stop request initiated with WfmHiStopApReq_t has been completed. The indication is also sent when the started network has encountered a fatal error.