ring_buffer.h

Go to the documentation of this file.

#pragma once

#ifdef USE_ESP32

#include <freertos/FreeRTOS.h>
#include <freertos/ringbuf.h>

#include <cinttypes>
#include <memory>

namespace esphome {

class RingBuffer {
 public:
  ~RingBuffer();

  size_t read(void *data, size_t len, TickType_t ticks_to_wait = 0);

  size_t write(const void *data, size_t len);

  size_t write_without_replacement(const void *data, size_t len, TickType_t ticks_to_wait = 0);

  size_t available() const;

  size_t free() const;

  BaseType_t reset();

  static std::unique_ptr<RingBuffer> create(size_t len);

 protected:
  bool discard_bytes_(size_t discard_bytes);

  RingbufHandle_t handle_{nullptr};
  StaticRingbuffer_t structure_;
  uint8_t *storage_{nullptr};
  size_t size_{0};
};

}  // namespace esphome

#endif