[][src]Function esp_idf_sys::xRingbufferReceive

pub unsafe extern "C" fn xRingbufferReceive(
    xRingbuffer: RingbufHandle_t,
    pxItemSize: *mut usize,
    xTicksToWait: TickType_t
) -> *mut c_void

@brief Retrieve an item from the ring buffer

Attempt to retrieve an item from the ring buffer. This function will block until an item is available or until it timesout.

@param[in] xRingbuffer Ring buffer to retrieve the item from @param[out] pxItemSize Pointer to a variable to which the size of the retrieved item will be written. @param[in] xTicksToWait Ticks to wait for items in the ring buffer.

@note A call to vRingbufferReturnItem() is required after this to free the item retrieved.

@return - Pointer to the retrieved item on success; *pxItemSize filled with the length of the item. - NULL on timeout, *pxItemSize is untouched in that case.