Function esp_idf_sys::vRingbufferGetInfo

pub unsafe extern "C" fn vRingbufferGetInfo(
    xRingbuffer: RingbufHandle_t,
    uxFree: *mut UBaseType_t,
    uxRead: *mut UBaseType_t,
    uxWrite: *mut UBaseType_t,
    uxAcquire: *mut UBaseType_t,
    uxItemsWaiting: *mut UBaseType_t,
)

@brief Get information about ring buffer status

Get information of a ring buffer’s current status such as free/read/write/acquire pointer positions, and number of items waiting to be retrieved. Arguments can be set to NULL if they are not required.

@param[in] xRingbuffer Ring buffer to remove from the queue set @param[out] uxFree Pointer use to store free pointer position @param[out] uxRead Pointer use to store read pointer position @param[out] uxWrite Pointer use to store write pointer position @param[out] uxAcquire Pointer use to store acquire pointer position @param[out] uxItemsWaiting Pointer use to store number of items (bytes for byte buffer) waiting to be retrieved