Function esp_idf_sys::xRingbufferCreateStatic

source ·
pub unsafe extern "C" fn xRingbufferCreateStatic(
    xBufferSize: usize,
    xBufferType: RingbufferType_t,
    pucRingbufferStorage: *mut u8,
    pxStaticRingbuffer: *mut StaticRingbuffer_t,
) -> RingbufHandle_t
Expand description

@brief Create a ring buffer but manually provide the required memory

@param[in] xBufferSize Size of the buffer in bytes. @param[in] xBufferType Type of ring buffer, see documentation @param[in] pucRingbufferStorage Pointer to the ring buffer’s storage area. Storage area must have the same size as specified by xBufferSize @param[in] pxStaticRingbuffer Pointed to a struct of type StaticRingbuffer_t which will be used to hold the ring buffer’s data structure

@note xBufferSize of no-split/allow-split buffers MUST be 32-bit aligned.

@return A handle to the created ring buffer