Function esp_idf_sys::xStreamBufferSpacesAvailable

source ยท
pub unsafe extern "C" fn xStreamBufferSpacesAvailable(
    xStreamBuffer: StreamBufferHandle_t,
) -> usize
Expand description

@cond !DOC_EXCLUDE_HEADER_SECTION stream_buffer.h

@code{c} size_t xStreamBufferSpacesAvailable( StreamBufferHandle_t xStreamBuffer ); @endcode @endcond

Queries a stream buffer to see how much free space it contains, which is equal to the amount of data that can be sent to the stream buffer before it is full.

@param xStreamBuffer The handle of the stream buffer being queried.

@return The number of bytes that can be written to the stream buffer before the stream buffer would be full.

@cond !DOC_SINGLE_GROUP \defgroup xStreamBufferSpacesAvailable xStreamBufferSpacesAvailable @endcond \ingroup StreamBufferManagement