esphome::api::APIOverflowBuffer::Entry Struct Reference

A single heap-allocated send-backlog entry. More...

#include <api_overflow_buffer.h>

Public Member Functions
uint16_t	remaining () const
const uint8_t *	current_data () const

Static Public Member Functions
static ESPHOME_ALWAYS_INLINE void	destroy (Entry *entry)
	Free this entry and its data buffer.

Data Fields
uint8_t *	data
uint16_t	size
uint16_t	offset

Detailed Description

A single heap-allocated send-backlog entry.

Lifetime is manually managed — see destroy().

Definition at line 29 of file api_overflow_buffer.h.

Member Function Documentation

current_data()

const uint8_t * esphome::api::APIOverflowBuffer::Entry::current_data ( ) const

inline

Definition at line 35 of file api_overflow_buffer.h.

destroy()

static ESPHOME_ALWAYS_INLINE void esphome::api::APIOverflowBuffer::Entry::destroy ( Entry * entry )

inlinestatic

Free this entry and its data buffer.

Definition at line 38 of file api_overflow_buffer.h.

remaining()

uint16_t esphome::api::APIOverflowBuffer::Entry::remaining ( ) const

inline

Definition at line 34 of file api_overflow_buffer.h.

Field Documentation

data

uint8_t* esphome::api::APIOverflowBuffer::Entry::data

Definition at line 30 of file api_overflow_buffer.h.

offset

uint16_t esphome::api::APIOverflowBuffer::Entry::offset

Definition at line 32 of file api_overflow_buffer.h.

size

uint16_t esphome::api::APIOverflowBuffer::Entry::size

Definition at line 31 of file api_overflow_buffer.h.

---

The documentation for this struct was generated from the following file:

• esphome/components/api/api_overflow_buffer.h