ESPHome  2024.9.0
ring_buffer.h
Go to the documentation of this file.
1 #pragma once
2 
3 #ifdef USE_ESP32
4 
5 #include <freertos/FreeRTOS.h>
6 #include <freertos/stream_buffer.h>
7 
8 #include <cinttypes>
9 #include <memory>
10 
11 namespace esphome {
12 
13 class RingBuffer {
14  public:
26  size_t read(void *data, size_t len, TickType_t ticks_to_wait = 0);
27 
38  size_t write(void *data, size_t len);
39 
51  size_t write_without_replacement(void *data, size_t len, TickType_t ticks_to_wait = 0);
52 
61  size_t available() const;
62 
71  size_t free() const;
72 
78  BaseType_t reset();
79 
80  static std::unique_ptr<RingBuffer> create(size_t len);
81 
82  protected:
83  StreamBufferHandle_t handle_;
84  StaticStreamBuffer_t structure_;
85  uint8_t *storage_;
86 };
87 
88 } // namespace esphome
89 
90 #endif
size_t write_without_replacement(void *data, size_t len, TickType_t ticks_to_wait=0)
Writes to the ring buffer without overwriting oldest data.
Definition: ring_buffer.cpp:49
uint8_t * storage_
Definition: ring_buffer.h:85
size_t free() const
Returns the number of free bytes in the ring buffer.
Definition: ring_buffer.cpp:55
StaticStreamBuffer_t structure_
Definition: ring_buffer.h:84
BaseType_t reset()
Resets the ring buffer, discarding all stored data.
Definition: ring_buffer.cpp:57
size_t read(void *data, size_t len, TickType_t ticks_to_wait=0)
Reads from the ring buffer, waiting up to a specified number of ticks if necessary.
Definition: ring_buffer.cpp:28
size_t available() const
Returns the number of available bytes in the ring buffer.
Definition: ring_buffer.cpp:53
std::string size_t len
Definition: helpers.h:292
Implementation of SPI Controller mode.
Definition: a01nyub.cpp:7
size_t write(void *data, size_t len)
Writes to the ring buffer, overwriting oldest data if necessary.
Definition: ring_buffer.cpp:39
static std::unique_ptr< RingBuffer > create(size_t len)
Definition: ring_buffer.cpp:14
StreamBufferHandle_t handle_
Definition: ring_buffer.h:83