xRingbufferReceive() function

Retrieve an item from the ring buffer Attempt to retrieve an item from the ring buffer. This function will block until an item is available or until it times out.

Syntax

Show:

Summary

Declaration

Definition

from ringbuf.h:234

void *xRingbufferReceive(RingbufHandle_t xRingbuffer, size_t *pxItemSize, TickType_t xTicksToWait);

Implemented in ringbuf.c:1101

Arguments

Argument

Description

xRingbuffer

Ring buffer to retrieve the item from

pxItemSize

Pointer to a variable to which the size of the retrieved item will be written.

xTicksToWait

Ticks to wait for items in the ring buffer.

Return value

- Pointer to the retrieved item on success; *pxItemSize filled with the length of the item. - NULL on timeout, *pxItemSize is untouched in that case.

Notes

A call to vRingbufferReturnItem() is required after this to free the item retrieved. It is possible to receive items with a pxItemSize of 0 on no-split/allow split buffers.

Examples

References

from examples

xRingbufferReceive() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle