blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-09 17:19:09 -04:00
Code Issues Projects Releases Wiki Activity

feat(esp_ringbuf): Update ring buffer doc

Browse Source 
Closes https://github.com/espressif/esp-idf/issues/15298
This commit is contained in:
Konstantin Kondrashov 2025-02-05 13:11:42 +02:00
parent 5a0e1615d9
commit 8155e60edf
1 changed files with 0 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
components/esp_ringbuf/include/freertos/ringbuf.h
View File

@ -420,10 +420,6 @@ size_t xRingbufferGetMaxItemSize(RingbufHandle_t xRingbuffer);
* buffer. This represents the maximum size an item/data can have if it was * buffer. This represents the maximum size an item/data can have if it was
* currently sent to the ring buffer. * currently sent to the ring buffer.
* *
* @warning This API is not thread safe. So, if multiple threads are accessing
* the same ring buffer, it is the application's responsibility to
* ensure atomic access to this API and the subsequent Send
*
* @note An empty no-split buffer has a max current free size for an item * @note An empty no-split buffer has a max current free size for an item
* that is limited to ((buffer_size/2)-header_size). See API reference * that is limited to ((buffer_size/2)-header_size). See API reference
* for xRingbufferGetMaxItemSize(). * for xRingbufferGetMaxItemSize().