Ring Buffer#

emberAfPluginRingBufferInitStruct#

EmberStatus emberAfPluginRingBufferInitStruct (EmberRingBuffer *ringBufferStruct, bool wideLengthField, EmberAfPluginRingBufferDeleteFunction *deleteCallback, uint8_t *dataPtr)

Initialize the ring buffer struct based on data passed. widLengthField determines whether the ring buffer uses 1 or 2 byte length fields for entry. wideLengthField = false uses 1 byte length, wideLengthField = true uses 2 byte lengths. All entries in the same ring buffer utilze the same size length field. Different ring buffers may use differnt sizes.

Returns

• EmberStatus status code

emberAfPluginRingBufferAddEntry#

EmberStatus emberAfPluginRingBufferAddEntry (EmberRingBuffer *ring, uint8_t *dataToAdd, uint16_t dataToAddSize)

Add an entry in the ring buffer.

Returns

• EmberStatus status code

emberAfPluginRingBufferGetEntryByEntryNumber#

EmberStatus emberAfPluginRingBufferGetEntryByEntryNumber (EmberRingBuffer *ring, uint16_t entryNumber, uint16_t dataIndexInEntry, uint16_t *returnEntryTotalSize, uint16_t maxReturnSize, uint16_t *returnDataSize, uint8_t *returnData)

Retrieve data from the specified entry. Returns the entry's total size in value pointed to by returnEntryTotalSize. The amount of data returned is written to the pointer returnDataSize. This allows for the caller to get the entry's total size at the same time they are able to grab a chunk of the entry up to some limit.

Returns

• EmberStatus status code

emberAfPluginRingBufferGetLastEntry#

EmberStatus emberAfPluginRingBufferGetLastEntry (EmberRingBuffer *ring, uint16_t dataIndexInEntry, uint16_t *returnEntryTotalSize, uint16_t maxReturnSize, uint16_t *returnDataSize, uint8_t *returnData)

Get the last entry of the ring buffer.

Returns

• EmberStatus status code

emberAfPluginRingBufferInitIterator#

EmberStatus emberAfPluginRingBufferInitIterator (EmberRingBuffer *ring)

Initialize the iterator to the first entry in the ring buffer. You may immediately call emberAfPluginRingBufferGetEntryByIterator() after this function is called.

Returns

• EmberStatus status code

emberAfPluginRingBufferIteratorNextEntry#

EmberStatus emberAfPluginRingBufferIteratorNextEntry (EmberRingBuffer *ring)

Iterate to next entry in ring buffer.

Returns

• EmberStatus status code

Note

• Return EMBER_OPERATION_IN_PROGRESS if there are more items left to iterate through. Returns EMBER_SUCCESS on reaching the last item, and the iterator is marked invalid (needs to be initialized again). Returns EMBER_INVALID_CALL if the iterator has not been initialized. An iterator can also be marked invalid if the ring buffer has deleted the entry that the iterator was currently on.

emberAfPluginRingBufferGetEntryByIterator#

EmberStatus emberAfPluginRingBufferGetEntryByIterator (EmberRingBuffer *ring, uint16_t dataIndexInEntry, uint16_t *returnEntryTotalSize, uint16_t maxReturnSize, uint16_t *returnDataSize, uint8_t *returnData)

Similar to emberAfPluginRingBufferGetEntryByEntryNumber().

Returns

• EmberStatus status code

Note

• The iterator must have already been initialized

emberAfPluginRingBufferUpdateEntryByIterator#

EmberStatus emberAfPluginRingBufferUpdateEntryByIterator (EmberRingBuffer *ring, uint16_t dataIndexInEntry, uint8_t *updatedData, uint16_t updatedDataLength)

Update a ring buffer entry by passing in the iterator.

Returns

• EmberStatus status code

emberAfPluginRingBufferAppendLastEntry#

EmberStatus emberAfPluginRingBufferAppendLastEntry (EmberRingBuffer *ring, uint8_t *dataToAdd, uint16_t dataToAddSize)

Append an entry to end of the ring buffer.

Returns

• EmberStatus status code

EmberAfPluginRingBufferDeleteFunction#

typedef void() EmberAfPluginRingBufferDeleteFunction(uint16_t entryNumber, uint16_t entrySize) (uint16_t entryNumber, uint16_t entrySize)

EMBER_AF_PLUGIN_RING_BUFFER_WIDE_LENGTH_ENTRY_OVERHEAD#

#define EMBER_AF_PLUGIN_RING_BUFFER_WIDE_LENGTH_ENTRY_OVERHEAD

2

EMBER_AF_PLUGIN_RING_BUFFER_NARROW_LENGTH_ENTRY_OVERHEAD#

#define EMBER_AF_PLUGIN_RING_BUFFER_NARROW_LENGTH_ENTRY_OVERHEAD

1

EMBER_AF_PLUGIN_RING_BUFFER_MAX_LENGTH_ENTRY_OVERHEAD#

#define EMBER_AF_PLUGIN_RING_BUFFER_MAX_LENGTH_ENTRY_OVERHEAD

EMBER_AF_PLUGIN_RING_BUFFER_WIDE_LENGTH_ENTRY_OVERHEAD