xRingbufferCreateWithCaps() function

Creates a ring buffer with specific memory capabilities This function is similar to xRingbufferCreate(), except that it allows the memory allocated for the ring buffer to have specific capabilities (e.g., MALLOC_CAP_INTERNAL).

Syntax

Show:

Summary

Declaration

Definition

from ringbuf.h:539

RingbufHandle_t xRingbufferCreateWithCaps(size_t xBufferSize, RingbufferType_t xBufferType, UBaseType_t uxMemoryCaps);

Implemented in ringbuf.c:1383

Arguments

Argument

Declared as

Description

xBufferSize

size_t

Size of the buffer in bytes

xBufferType

RingbufferType_t

Type of ring buffer, see documentation.

uxMemoryCaps

UBaseType_t

Memory capabilities of the queue's memory (see esp_heap_caps.h)

Return value

Handle to the created ring buffer or NULL on failure.

Notes

A queue created using this function must only be deleted using vRingbufferDeleteWithCaps()

Examples

References

from examples

xRingbufferCreateWithCaps() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle