ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::api::DeferredBatch Struct Reference

#include <api_deferred_batch.h>

Data Structures

struct  BatchItem
 

Public Member Functions

bool contains (EntityBase *entity, uint16_t message_type) const
 
void add_item (EntityBase *entity, uint16_t message_type, uint8_t estimated_size, uint8_t aux_data_index=AUX_DATA_UNUSED)
 
void add_item_front (EntityBase *entity, uint16_t message_type, uint8_t estimated_size)
 
void clear ()
 
void remove_front (size_t count) __attribute__((noinline))
 
bool empty () const
 
size_t size () const
 
const BatchItem & operator[] (size_t index) const
 
void release_buffer ()
 

Data Fields

std::vector< BatchItem > items
 
uint32_t batch_start_time {0}
 

Static Public Attributes

static constexpr uint8_t AUX_DATA_UNUSED = std::numeric_limits<uint8_t>::max()
 

Detailed Description

Definition at line 16 of file api_deferred_batch.h.

Member Function Documentation

◆ add_item()

void esphome::api::DeferredBatch::add_item ( EntityBase * entity,
uint16_t message_type,
uint8_t estimated_size,
uint8_t aux_data_index = AUX_DATA_UNUSED )
inline

Definition at line 43 of file api_deferred_batch.h.

◆ add_item_front()

void esphome::api::DeferredBatch::add_item_front ( EntityBase * entity,
uint16_t message_type,
uint8_t estimated_size )
inline

Definition at line 56 of file api_deferred_batch.h.

◆ clear()

void esphome::api::DeferredBatch::clear ( )
inline

Definition at line 64 of file api_deferred_batch.h.

◆ contains()

bool esphome::api::DeferredBatch::contains ( EntityBase * entity,
uint16_t message_type ) const
inline

Definition at line 34 of file api_deferred_batch.h.

◆ empty()

bool esphome::api::DeferredBatch::empty ( ) const
inline

Definition at line 72 of file api_deferred_batch.h.

◆ operator[]()

const BatchItem & esphome::api::DeferredBatch::operator[] ( size_t index) const
inline

Definition at line 74 of file api_deferred_batch.h.

◆ release_buffer()

void esphome::api::DeferredBatch::release_buffer ( )
inline

Definition at line 77 of file api_deferred_batch.h.

◆ remove_front()

void esphome::api::DeferredBatch::remove_front ( size_t count)
inline

Definition at line 70 of file api_deferred_batch.h.

◆ size()

size_t esphome::api::DeferredBatch::size ( ) const
inline

Definition at line 73 of file api_deferred_batch.h.

Field Documentation

◆ AUX_DATA_UNUSED

uint8_t esphome::api::DeferredBatch::AUX_DATA_UNUSED = std::numeric_limits<uint8_t>::max()
staticconstexpr

Definition at line 18 of file api_deferred_batch.h.

◆ batch_start_time

uint32_t esphome::api::DeferredBatch::batch_start_time {0}

Definition at line 28 of file api_deferred_batch.h.

◆ items

std::vector<BatchItem> esphome::api::DeferredBatch::items

Definition at line 27 of file api_deferred_batch.h.


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