xRingbufferGetCurFreeSize() function

Get current free size available for an item/data in the buffer This gives the real time free space available for an item/data in the ring buffer. This represents the maximum size an item/data can have if it was currently sent to the ring buffer. @warning This API is not thread safe. So, if multiple threads are accessing the same ring buffer, it is the application's responsibility to ensure atomic access to this API and the subsequent Send

Syntax

Show:

Summary

Declaration

Definition

from ringbuf.h:435

size_t xRingbufferGetCurFreeSize(RingbufHandle_t xRingbuffer);

Implemented in ringbuf.c:1264

Arguments

Argument

Description

xRingbuffer

Ring buffer to query

Return value

Current free size, in bytes, available for an entry

Notes

An empty no-split buffer has a max current free size for an item that is limited to ((buffer_size/2)-header_size). See API reference for xRingbufferGetMaxItemSize().