xStreamBufferCreateWithCaps() function

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

Syntax

Show:

Summary

Declaration

from idf_additions.h:534

static inline StreamBufferHandle_t xStreamBufferCreateWithCaps( size_t xBufferSizeBytes, size_t xTriggerLevelBytes, UBaseType_t uxMemoryCaps );

Arguments

Argument

Description

xBufferSizeBytes

The total number of bytes the stream buffer will be able to hold at any one time.

xTriggerLevelBytes

The number of bytes that must be in the stream buffer before unblocking

uxMemoryCaps

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

Return value

Handle to the created stream buffer or NULL on failure.

Notes

A stream buffer created using this function must only be deleted using vStreamBufferDeleteWithCaps()

References

Code

Location

static inline StreamBufferHandle_t xStreamBufferCreateWithCaps( size_t xBufferSizeBytes,

idf_additions.h:534

Call Tree

xStreamBufferCreateWithCaps() calls 1 function:

xStreamBufferCreateWithCaps()

xStreamBufferGenericCreateWithCaps()

Data Use

xStreamBufferCreateWithCaps():

xStreamBufferCreateWithCaps()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out