Function esp_idf_sys::xStreamBufferIsFull

source · 
pub unsafe extern "C" fn xStreamBufferIsFull(
    xStreamBuffer: StreamBufferHandle_t
) -> BaseType_t
Expand description

@cond !DOC_EXCLUDE_HEADER_SECTION stream_buffer.h

@code{c} BaseType_t xStreamBufferIsFull( StreamBufferHandle_t xStreamBuffer ); @endcode @endcond

Queries a stream buffer to see if it is full. A stream buffer is full if it does not have any free space, and therefore cannot accept any more data.

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

@return If the stream buffer is full then pdTRUE is returned. Otherwise pdFALSE is returned.

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