[][src]Function esp_idf_sys::xRingbufferGetCurFreeSize

pub unsafe extern "C" fn xRingbufferGetCurFreeSize(
    xRingbuffer: RingbufHandle_t
) -> usize

@brief 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

@param[in] xRingbuffer Ring buffer to query

@return Current free size, in bytes, available for an entry