Sleepy Message Queue#

emberAfPluginSleepyMessageQueueGetNumUnusedEntries#

uint8_t emberAfPluginSleepyMessageQueueGetNumUnusedEntries (void )

Return the number of unused entries in the sleepy message queue.

emberAfPluginSleepyMessageQueueStoreMessage#

EmberAfSleepyMessageId emberAfPluginSleepyMessageQueueStoreMessage (EmberAfSleepyMessage * pmsg, uint32_t timeoutSec)

Store an EmberAfSleepyMessage to the sleepy message queue if an entry is available.

Returns

• The EmberAfSleepyMessageId assigned to the message if stored, or EMBER_AF_PLUGING_SLEEPY_MESSAGE_INVALID_ID if the message could not be stored to the queue. The message may not be stored if the queue is full, or the time duration exceeds the maximum duration.

sli_zigbee_af_message_m_sec_remaining#

uint32_t sli_zigbee_af_message_m_sec_remaining (EmberAfSleepyMessageId sleepyMsgId)

Return the number of milliseconds remaining until the sleepy message expires.

Returns

• The number of milliseconds until the specified message expires, or 0xFFFFFFFF if a matching active message cannot be found.

emberAfPluginSleepyMessageQueueGetPendingMessageId#

EmberAfSleepyMessageId emberAfPluginSleepyMessageQueueGetPendingMessageId (EmberEUI64 dstEui64)

Return the next EmberAfSleepyMessageId value (that will expire next) for a given EmberEUI64.

Returns

• The EmberAfSleepyMessageId value of the next-expiring message for the specified EmberEUI64 if a match was found, or EMBER_AF_PLUGIN_SLEEPY_MESSAGE_INVALID_ID if a matching entry was not found.

emberAfPluginSleepyMessageQueueGetPendingMessage#

bool emberAfPluginSleepyMessageQueueGetPendingMessage (EmberAfSleepyMessageId sleepyMsgId, EmberAfSleepyMessage * pmsg)

Search the sleepy message queue for an entry with the specified EmberAfSleepyMessageId.

If a match was found, it copies the message into the EmberAfSleepyMessage structure pointer.

Returns

• true if a matching message was found or false if a match was not found.

emberAfPluginSleepyMessageQueueGetNextMessageEventTimeoutMs#

uint32_t emberAfPluginSleepyMessageQueueGetNextMessageEventTimeoutMs (void )

Return the time in milliseconds until the next message in the sleepy message queue will timeout.

Returns

• The remaining time in milliseconds until the next message will timeout.

emberAfPluginSleepyMessageQueueGetNumMessages#

uint8_t emberAfPluginSleepyMessageQueueGetNumMessages (EmberEUI64 dstEui64)

Return the number of messages in the sleepy message queue that are buffered for a given EmberEUI64.

Returns

• The number of messages in the sleepy message queue that are being sent to the specified EmberEUI64.

emberAfPluginSleepyMessageQueueRemoveMessage#

bool emberAfPluginSleepyMessageQueueRemoveMessage (EmberAfSleepyMessageId sleepyMsgId)

Remove the message from the sleepy message queue with the specified EmberAfSleepyMessageId.

Returns

• true if a matching EmberAfSleepyMessageId was found and removed from the sleepy message queue, or false if not.

emberAfPluginSleepyMessageQueueRemoveAllMessages#

void emberAfPluginSleepyMessageQueueRemoveAllMessages (EmberEUI64 dstEui64)

Remove all messages from the sleepy message queue whose destination address matches the specified EmberEUI64.

EmberAfSleepyMessageId#

typedef uint8_t EmberAfSleepyMessageId

EMBER_AF_PLUGIN_SLEEPY_MESSAGE_INVALID_ID#

#define EMBER_AF_PLUGIN_SLEEPY_MESSAGE_INVALID_ID

0xFF