Module to declare MAC MLME Disassociate API. More...
Data Structures |
|
| struct | mlme_disassociate_conf_t |
|
MLME-DISASSOCIATE.confirm.
More...
|
|
| struct | mlme_disassociate_req_t |
|
MLME-DISASSOCIATE.request.
More...
|
|
| struct | mlme_disassociate_ind_t |
|
MLME-DISASSOCIATE.indication.
More...
|
|
Typedefs |
|
| typedef void(* | mlme_disassociate_conf_cb_t )( mlme_disassociate_conf_t *) |
|
Customer's function of confirmation.
More...
|
|
Enumerations |
|
| enum |
mac_disassociate_reason_t
{
MAC_COORD_REASON = 1, MAC_DEV_REASON = 2 } |
|
MAC Disassociation Reason field.
More...
|
|
Functions |
|
| void | mlme_disassociate_req ( mlme_disassociate_req_t *req, mlme_disassociate_conf_cb_t conf_cb) |
|
MLME-DISASSOCIATE request.
More...
|
|
| void | mlme_disassociate_ind ( mlme_disassociate_ind_t *ind) |
|
MLME-DISASSOCIATE indication handler.
More...
|
|
Detailed Description
Module to declare MAC MLME Disassociate API.
The MLME Disassociation module declares Disassociation MAC routines and necessary types according to the MAC specification. More specifically, MLME Disassociation request aka mlme_disassociate_req() , MLME Disassociation confirm callback typedef aka mlme_disassociate_conf_cb_t, and MLME Disassociation indication as mlme_disassociate_ind() primitives are declared.
Typedef Documentation
| typedef void(* mlme_disassociate_conf_cb_t)( mlme_disassociate_conf_t *) |
Customer's function of confirmation.
The MLME-DISASSOCIATE.confirm primitive is generated by the initiating MLME and issued to its next higher layer in response to an MLME-DISASSOCIATE.request primitive. This primitive returns a status of either SUCCESS, indicating that the disassociation request was successful, or the appropriate error code. The status values are fully described in 7.1.4.1.3 and subclauses referenced by 7.1.4.1.3.
- Parameters
-
pointer to confirmation primitive
Enumeration Type Documentation
Function Documentation
| void mlme_disassociate_ind | ( | mlme_disassociate_ind_t * | ind | ) |
MLME-DISASSOCIATE indication handler.
Indicates an disassociation with a PAN
- Parameters
-
ind MLME_DISASSOCIATE indication structure.
In accordance with IEEE Std 802.15.4-2006, section 7.1.4.4
| void mlme_disassociate_req | ( | mlme_disassociate_req_t * | req , |
| mlme_disassociate_conf_cb_t | conf_cb | ||
| ) |
MLME-DISASSOCIATE request.
Request disassociation with a PAN After request completion, user callback will be issued with valid data stored in structure mlme_disassociate_conf_t .
- Parameters
-
req MLME_DISASSOCIATE request structure. conf_cb pointer to user callback.
In accordance with IEEE Std 802.15.4-2006, section 7.1.4.4