2.3.3 WPAN_MLME_GetReq Function

C

bool WPAN_MLME_GetReq(uint8_t PIBAttribute)

Summary

It Initiates MLME-GET.request service and have it placed in the MLME-SAP queue.

Description

This function is used to request the information about the given PIB attribute. It Initiates MLME-GET.request service and have it placed in the MLME-SAP queue. The MLME-GET.request primitive requests information about a given PIB attribute.

Precondition

WPAN_Init() should have been called before calling this function.

Parameters

ParamDescription
PIBAttributePIB attribute to be retrieved
PIBAttributeIndexIndex of the PIB attribute to be read

Returns

true - success; false - buffer not available or queue full.

Example

uint8_t phyCurrentPage;

bool retVal = false;
retVal = WPAN_MLME_GetReq(phyCurrentPage)
if (true != retVal)
{
    printf("buffer not available or queue full");
}

Remarks

On the receipt of WPAN_MLME_GetReq, MAC layer will perform respective operation and asynchronously invokes USR_MLME_GetConf with proper status.