Symbols

Files

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFxRingbufferCreateStatic()

xRingbufferCreateStatic() function

Create a ring buffer but manually provide the required memory

Syntax

Show:

Summary

Declaration

Definition

from ringbuf.h:108

RingbufHandle_t xRingbufferCreateStatic(size_t xBufferSize, RingbufferType_t xBufferType, uint8_t *pucRingbufferStorage, StaticRingbuffer_t *pxStaticRingbuffer);

Implemented in ringbuf.c:964

Arguments

Argument

Description

xBufferSize

Size of the buffer in bytes.

xBufferType

Type of ring buffer, see documentation

pucRingbufferStorage

Pointer to the ring buffer's storage area. Storage area must have the same size as specified by xBufferSize

pxStaticRingbuffer

Pointed to a struct of type StaticRingbuffer_t which will be used to hold the ring buffer's data structure

Return value

A handle to the created ring buffer

Notes

xBufferSize of no-split/allow-split buffers MUST be 32-bit aligned.

References

Code

Location

Referrer

RingbufHandle_t xRingbufferCreateStatic(size_t xBufferSize,

ringbuf.c:964

RingbufHandle_t xRingbufferCreateStatic(size_t xBufferSize,

ringbuf.h:108

adc_ctx->ringbuf_hdl = xRingbufferCreateStatic(hdl_config->max_store_buf_size, RINGBUF_TYPE_BYTEBUF, adc_ctx->ringbuf_storage, adc_ctx->ringbuf_struct);

adc_continuous.c:189

adc_continuous_new_handle()

xRingbuffer = xRingbufferCreateStatic(xBufferSize, xBufferType, pucRingbufferStorage, pxStaticRingbuffer);

ringbuf.c:1402

xRingbufferCreateWithCaps()

Call Tree

xRingbufferCreateStatic() is called by 2 functions and calls 2 functions:

xRingbufferCreateWithCaps()

adc_continuous_new_handle()

xRingbufferCreateStatic()

__assert_func()

prvInitializeNewRingbuffer()

Data Use

xRingbufferCreateStatic() reads 3 variables and writes 1 variable:

RingbufferType_t::RINGBUF_TYPE_BYTEBUF

RingbufferType_t::RINGBUF_TYPE_MAX

RingbufferDefinition::uxRingbufferFlags

xRingbufferCreateStatic()

RingbufferDefinition::uxRingbufferFlags

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out