Module to declare MAC MCPS Purge API. More...

Data Structures
struct	mcps_purge_conf_t
	MCPS-PURGE.confirm. More...
struct	mcps_purge_req_t
	MCPS-PURGE.request. More...

Typedefs
typedef void(*	mcps_purge_conf_cb_t )( mcps_purge_conf_t *)
	Confirmation function. More...

Functions
void	mcps_purge_req ( mcps_purge_req_t *req, mcps_purge_conf_cb_t conf_cb)
	MCPS-PURGE.request service. More...
mac_status_t	mcps_purge ( mcps_purge_req_t *req)
	Performs MCPS-PURGE.request directly (without request - confirm approach). More...

Detailed Description

Module to declare MAC MCPS Purge API.

The MAC MCPS Purge module declares the MAC Purge routines and necessary types according to the MAC specification. More specifically, MAC purge request mcps_purge_req() , and the confirmation callback typedef is declared as mcps_purge_conf_cb_t. An additional primitive not covered by the standard is declared. This is mpcs_purge() which is a synchronous version of mcps_purge_req() .

Typedef Documentation

typedef void(* mcps_purge_conf_cb_t)( mcps_purge_conf_t *)

Confirmation function.

The MCPS-PURGE.confirm primitive is generated by the MAC sublayer entity in response to an MCPS-PURGE.request primitive. The MCPS-PURGE.confirm primitive returns a status of either SUCCESS, indicating that the purge request was successful, or INVALID_HANDLE, indicating an error. The status values are fully described in 7.1.1.4.3.

Parameters

Pointer

to confirmation primitive.

Function Documentation

mac_status_t mcps_purge

(

mcps_purge_req_t *

req

)

Performs MCPS-PURGE.request directly (without request - confirm approach).

Optional. Not covered by the standard.

The MCPS-PURGE.request primitive is generated by the next higher layer whenever an MSDU is to be purged from the transaction queue.

Parameters

req	Pointer to MCPS-PURGE request structure.

Returns

Result of the purge procedure.

void mcps_purge_req	(	mcps_purge_req_t *	req ,
		mcps_purge_conf_cb_t	conf_cb
	)

MCPS-PURGE.request service.

The MCPS-PURGE.request primitive is generated by the next higher layer whenever an MSDU is to be purged from the transaction queue. After request completion, user callback will be issued with valid data stored in structure mcps_purge_conf_t .

Parameters

req	Pointer to MCPS-PURGE request structure.
conf_cb	Pointer to the confirmation function (user callback).

In accordance with IEEE Std 802.15.4-2006, section 7.1.1.4.