Symbols ![]()
loading...
Files ![]()
loading...
xRingbufferReceiveSplit() function
Retrieve a split item from an allow-split ring buffer Attempt to retrieve a split item from an allow-split ring buffer. If the item is not split, only a single item is retried. If the item is split, both parts will be retrieved. This function will block until an item is available or until it times out.
Syntax
BaseType_t xRingbufferReceiveSplit(RingbufHandle_t xRingbuffer,
void **ppvHeadItem,
void **ppvTailItem,
size_t *pxHeadItemSize,
size_t *pxTailItemSize,
TickType_t xTicksToWait);
Implemented in ![]()
ringbuf.c:1133
Return value
- pdTRUE if an item (split or unsplit) was retrieved - pdFALSE when no item was retrieved
Notes
Call(s) to vRingbufferReturnItem() is required after this to free up the item(s) retrieved. This function should only be called on allow-split buffers It is possible to receive items with a pxItemSize of 0 on allow split buffers.