2.12.1 WPAN_MLME_OrphanResp Function

C

bool WPAN_MLME_OrphanResp(uint64_t OrphanAddress, uint16_t ShortAddress, bool AssociatedMember)

Summary

Initiate MLME-ORPHAN.response service and have it placed in MLME_SAP queue.

Description

This function is used to allow the next higher layer of a coordinator to respond to the MLME-ORPHAN.indication primitive. It initiates MLME-ORPHAN.response service and have it placed in MLME_SAP queue. The MLME-ORPHAN.indication primitive allows the MLME of a coordinator to notify the next higher layer of the presence of an orphaned device.

Precondition

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

Parameters

ParamDescription
OrphanAddressAddress of orphaned device
ShortAddressShort address allocated to orphaned device
AssociatedMemberBoolean true if the orphaned device is associated

Returns

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

Example

uint64_t OrphanAddress = 0x0000111100001111;
uint16_t shortaddr = 0x0001;

bool retVal = false;
retVal = WPAN_MLME_OrphanResp(OrphanAddress,shortaddr, true)
if (true != retVal)
{
     printf("buffer not available or queue full");
}

Remarks

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