Module to declare MAC MLME Poll API. More...

Data Structures
struct	mlme_poll_conf_t
	MLME-POLL.confirm. More...
struct	mlme_poll_req_t
	MLME-POLL.request. More...
struct	mlme_poll_ind_t
	MLME-Poll.indication. More...

Typedefs
typedef void(*	mlme_poll_conf_cb_t )( mlme_poll_conf_t *)
	Prototype of the user-implemented MLME-POLL.confirm callback function. More...

Functions
void	mlme_poll_req ( mlme_poll_req_t *req, mlme_poll_conf_cb_t conf_cb)
	MLME-POLL.request. More...
void	mlme_poll_ind ( mlme_poll_ind_t *p_ind)
	MLME-POLL.indication. More...

Detailed Description

Module to declare MAC MLME Poll API.

The MAC Poll module declares MLME Poll primitives and necessary types according to the MAC specification. More specifically, MLME Poll request aka mlme_poll_req() , MLME Poll indicaton aka mlme_poll_ind() , and MLME Poll confirm callback typedef aka mlme_poll_conf_cb_t primitives are declared.

Typedef Documentation

typedef void(* mlme_poll_conf_cb_t)( mlme_poll_conf_t *)

Prototype of the user-implemented MLME-POLL.confirm callback function.

The MLME-POLL.confirm primitive is generated by the MLME and issued to its next higher layer in response to an MLME-POLL.request primitive. If the request was successful, the status parameter will be equal to SUCCESS, indicating a successful poll for data. Otherwise, the status parameter indicates the appropriate error code. The status values are fully described in 7.1.16.1.3 and the subclauses referenced by 7.1.16.1.3.

Parameters

pointer

to a confirmation primitive.

Function Documentation

void mlme_poll_ind

(

mlme_poll_ind_t *

p_ind

)

MLME-POLL.indication.

The MLME-Poll.indication primitive notifies the next higher level that a request for data has been received.

Parameters

[in]

p_ind

pointer to a poll indication structure

void mlme_poll_req	(	mlme_poll_req_t *	req ,
		mlme_poll_conf_cb_t	conf_cb
	)

MLME-POLL.request.

The MLME-POLL.request primitive is generated by the next higher layer and issued to its MLME when data are to be requested from a coordinator.

Parameters

[in]	req	MLME-POLL.request parameters
[in]	conf_cb	User-implemented callback function, which will be called by MLME in order to pass MLME-POLL.confirm to the user.