Sleepy Message Queue#

sl_zigbee_af_sleepy_message_queue_get_num_unused_entries#

uint8_t sl_zigbee_af_sleepy_message_queue_get_num_unused_entries (void )

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

sl_zigbee_af_sleepy_message_queue_store_message#

sl_zigbee_af_sleepy_message_id_t sl_zigbee_af_sleepy_message_queue_store_message (sl_zigbee_af_sleepy_message_t * pmsg, uint32_t timeoutSec)

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

Returns

• The sl_zigbee_af_sleepy_message_id_t assigned to the message if stored, or SL_ZIGBEE_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 (sl_zigbee_af_sleepy_message_id_t 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.

sl_zigbee_af_sleepy_message_queue_get_pending_message_id#

sl_zigbee_af_sleepy_message_id_t sl_zigbee_af_sleepy_message_queue_get_pending_message_id (sl_802154_long_addr_t dstEui64)

Return the next sl_zigbee_af_sleepy_message_id_t value (that will expire next) for a given sl_802154_long_addr_t.

Returns

• The sl_zigbee_af_sleepy_message_id_t value of the next-expiring message for the specified sl_802154_long_addr_t if a match was found, or SL_ZIGBEE_AF_PLUGIN_SLEEPY_MESSAGE_INVALID_ID if a matching entry was not found.

sl_zigbee_af_sleepy_message_queue_get_pending_message#

bool sl_zigbee_af_sleepy_message_queue_get_pending_message (sl_zigbee_af_sleepy_message_id_t sleepyMsgId, sl_zigbee_af_sleepy_message_t * pmsg)

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

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

Returns

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

sl_zigbee_af_sleepy_message_queue_get_next_message_event_timeout_ms#

uint32_t sl_zigbee_af_sleepy_message_queue_get_next_message_event_timeout_ms (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.

sl_zigbee_af_sleepy_message_queue_get_num_messages#

uint8_t sl_zigbee_af_sleepy_message_queue_get_num_messages (sl_802154_long_addr_t dstEui64)

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

Returns

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

sl_zigbee_af_sleepy_message_queue_remove_message#

bool sl_zigbee_af_sleepy_message_queue_remove_message (sl_zigbee_af_sleepy_message_id_t sleepyMsgId)

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

Returns

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

sl_zigbee_af_sleepy_message_queue_remove_all_messages#

void sl_zigbee_af_sleepy_message_queue_remove_all_messages (sl_802154_long_addr_t dstEui64)

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

sl_zigbee_af_sleepy_message_id_t#

typedef uint8_t sl_zigbee_af_sleepy_message_id_t

SL_ZIGBEE_AF_PLUGIN_SLEEPY_MESSAGE_INVALID_ID#

#define SL_ZIGBEE_AF_PLUGIN_SLEEPY_MESSAGE_INVALID_ID

0xFF