espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-02 12:14:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add more information on how to return an item to the ring buffer

Browse Source
This commit is contained in:
He Hui Zi
2020-09-11 14:32:39 +08:00
committed by Krzysztof Budzynski
parent eda151992b
commit 874876cbf9
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/en/api-reference/system/freertos_additions.rst
View File

@@ -25,11 +25,11 @@ Ring Buffers
The ESP-IDF FreeRTOS ring buffer is a strictly FIFO buffer that supports arbitrarily sized items. The ESP-IDF FreeRTOS ring buffer is a strictly FIFO buffer that supports arbitrarily sized items.
Ring buffers are a more memory efficient alternative to FreeRTOS queues in situations where the Ring buffers are a more memory efficient alternative to FreeRTOS queues in situations where the
size of items is variable. The capacity of a ring buffer is not measured by the number of items size of items is variable. The capacity of a ring buffer is not measured by the number of items
it can store, but rather by the amount of memory used for storing items. You may apply for a it can store, but rather by the amount of memory used for storing items. The ring buffer provides API
piece of memory on the ring buffer to send an item, or just use the API to copy your data and send to send an item, or to allocate space for an item in the ring buffer to be filled manually by the user.
(according to the send API you call). For efficiency reasons, For efficiency reasons,
**items are always retrieved from the ring buffer by reference**. As a result, all retrieved **items are always retrieved from the ring buffer by reference**. As a result, all retrieved
items *must also be returned* in order for them to be removed from the ring buffer completely. items *must also be returned* to the ring buffer by using :cpp:func:`vRingbufferReturnItem` or :cpp:func:`vRingbufferReturnItemFromISR`, in order for them to be removed from the ring buffer completely.
The ring buffers are split into the three following types: The ring buffers are split into the three following types:
**No-Split** buffers will guarantee that an item is stored in contiguous memory and will not **No-Split** buffers will guarantee that an item is stored in contiguous memory and will not