api_overflow_buffer.h

Go to the documentation of this file.

#pragma once
#include <array>
#include <cstdint>
#include <sys/types.h>
 
#include "esphome/core/defines.h"
#ifdef USE_API
 
#include "esphome/components/socket/headers.h"
#include "esphome/components/socket/socket.h"
#include "esphome/core/helpers.h"
 
namespace esphome::api {
 
class APIOverflowBuffer {
 public:
  struct Entry {
    uint8_t *data;
    uint16_t size;    // Total size of the buffer
    uint16_t offset;  // Current send offset within the buffer
 
    uint16_t remaining() const { return this->size - this->offset; }
    const uint8_t *current_data() const { return this->data + this->offset; }
 
    static ESPHOME_ALWAYS_INLINE void destroy(Entry *entry) {
      delete[] entry->data;
      delete entry;  // NOLINT(cppcoreguidelines-owning-memory)
    }
  };
 
  ~APIOverflowBuffer();
 
  bool empty() const { return this->count_ == 0; }
 
  bool full() const { return this->count_ >= API_MAX_SEND_QUEUE; }
 
  uint8_t count() const { return this->count_; }
 
  ssize_t try_drain(socket::Socket *socket);
 
  bool enqueue_iov(const struct iovec *iov, int iovcnt, uint16_t total_len, uint16_t skip);
 
 protected:
  std::array<Entry *, API_MAX_SEND_QUEUE> queue_{};
  uint8_t head_{0};
  uint8_t tail_{0};
  uint8_t count_{0};
};
 
}  // namespace esphome::api
 
#endif  // USE_API