2.14.1 WPAN_MLME_RxEnableReq Function

C

bool WPAN_MLME_RxEnableReq(bool DeferPermit, uint32_t RxOnTime, uint32_t RxOnDuration)

Summary

Initiate MLME-RX-ENABLE.request service and have it placed in the MLME-SAP queue.

Description

This function is used by the NHLE layer to request that the receiver is either enabled for a finite period of time or disabled. It initiates MLME-RX-ENABLE.request service and have it placed in the MLME-SAP queue.

Precondition

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

Parameters

ParamDescription
DeferPermitSet to true if receiver enable can be deferred until next super frame if requested time has already passed
RxOnTimeNumber of symbols from start of superframe before receiver
RxOnDurationNumber of symbols for which the receiver is enabled

Returns

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

Example

bool retVal = false;
bool DeferPermit = true;
uint32_t RxOnTime = 0x000000;
uint32_t RxOnDuration = 100;
retVal = WPAN_MLME_RxEnableReq(DeferPermit, RxOnTime, RxOnDuration);
if (true != retVal)
{
     printf("buffer not available or queue full");
}

Remarks

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