SourceVu will show references to xRingbufferReceiveUpTo() from the following samples and libraries:
Symbols ![]()
loading...
Files ![]()
loading...
xRingbufferReceiveUpTo() function
Retrieve bytes from a byte buffer, specifying the maximum amount of bytes to retrieve Attempt to retrieve data from a byte buffer whilst specifying a maximum number of bytes to retrieve. This function will block until there is data available for retrieval or until it times out.
Syntax
void *xRingbufferReceiveUpTo(RingbufHandle_t xRingbuffer,
size_t *pxItemSize,
TickType_t xTicksToWait,
size_t xMaxSize);
Implemented in ![]()
ringbuf.c:1164
Return value
- Pointer to the retrieved item on success; *pxItemSize filled with the length of the item. - NULL on timeout, *pxItemSize is untouched in that case.
Notes
A call to vRingbufferReturnItem() is required after this to free up the data retrieved. This function should only be called on byte buffers Byte buffers do not allow multiple retrievals before returning an item Two calls to RingbufferReceiveUpTo() are required if the bytes wrap around the end of the ring buffer.