xRingbufferReceiveFromISR() function

Retrieve an item from the ring buffer in an ISR Attempt to retrieve an item from the ring buffer. This function returns immediately if there are no items available for retrieval

Syntax

Show:

Summary

Declaration

Definition

from ringbuf.h:255

void *xRingbufferReceiveFromISR(RingbufHandle_t xRingbuffer, size_t *pxItemSize);

Implemented in ringbuf.c:1117

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.

Return value

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

Notes

A call to vRingbufferReturnItemFromISR() is required after this to free the item retrieved. Byte buffers do not allow multiple retrievals before returning an item Two calls to RingbufferReceiveFromISR() are required if the bytes wrap around the end of the ring buffer. It is possible to receive items with a pxItemSize of 0 on no-split/allow split buffers.

Examples

References

from examples

xRingbufferReceiveFromISR() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle