vRingbufferGetInfo() function

Get information about ring buffer status Get information of a ring buffer's current status such as free/read/write/acquire pointer positions, and number of items waiting to be retrieved. Arguments can be set to NULL if they are not required.

Syntax

Show:

Summary

Declaration

Definition

from ringbuf.h:500

void vRingbufferGetInfo(RingbufHandle_t xRingbuffer, UBaseType_t *uxFree, UBaseType_t *uxRead, UBaseType_t *uxWrite, UBaseType_t *uxAcquire, UBaseType_t *uxItemsWaiting);

Implemented in ringbuf.c:1324

Arguments

Argument

Declared as

Description

xRingbuffer

RingbufHandle_t

Ring buffer handle

uxFree

UBaseType_t *

Pointer use to store free pointer position

uxRead

UBaseType_t *

Pointer use to store read pointer position

uxWrite

UBaseType_t *

Pointer use to store write pointer position

uxAcquire

UBaseType_t *

Pointer use to store acquire pointer position

uxItemsWaiting

UBaseType_t *

Pointer use to store number of items (bytes for byte buffer) waiting to be retrieved

Examples

vRingbufferGetInfo() is referenced by 2 libraries and example projects:

References

from examples

vRingbufferGetInfo() function

Syntax

Arguments

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle