xRingbufferCanRead() function

Check if the selected queue set member is a particular ring buffer This API checks if queue set member returned from xQueueSelectFromSet() is a particular ring buffer. If so, this indicates the ring buffer has items waiting to be retrieved.

Syntax

Show:

Summary

Declaration

from ringbuf.h:466

static inline BaseType_t xRingbufferCanRead(RingbufHandle_t xRingbuffer, QueueSetMemberHandle_t xMember);

Arguments

Argument

Description

xRingbuffer

Ring buffer to check

xMember

Member returned from xQueueSelectFromSet

Return value

- pdTRUE when selected queue set member is the ring buffer - pdFALSE otherwise.

References

Code

Location

static inline BaseType_t xRingbufferCanRead(RingbufHandle_t xRingbuffer, QueueSetMemberHandle_t xMember)

ringbuf.h:466

Call Tree

All items filtered out

Data Use

xRingbufferCanRead():

xRingbufferCanRead()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out