Function esp_idf_sys::xRingbufferCreate

source ·

pub unsafe extern "C" fn xRingbufferCreate(
    xBufferSize: usize,
    xBufferType: RingbufferType_t
) -> RingbufHandle_t

Expand description

@brief Create a ring buffer

@param[in] xBufferSize Size of the buffer in bytes. Note that items require space for a header in no-split/allow-split buffers @param[in] xBufferType Type of ring buffer, see documentation.

@note xBufferSize of no-split/allow-split buffers will be rounded up to the nearest 32-bit aligned size.

@return A handle to the created ring buffer, or NULL in case of error.