ESPHome 2025.7.5
Loading...
Searching...
No Matches
esphome::api::APIConnection::DeferredBatch Struct Reference

#include <api_connection.h>

Data Structures

struct  BatchItem
 

Public Member Functions

 DeferredBatch ()
 
 ~DeferredBatch ()
 
void add_item (EntityBase *entity, MessageCreator creator, uint8_t message_type, uint8_t estimated_size)
 
void add_item_front (EntityBase *entity, MessageCreator creator, uint8_t message_type, uint8_t estimated_size)
 
void clear ()
 
void remove_front (size_t count)
 
bool empty () const
 
size_t size () const
 
const BatchItemoperator[] (size_t index) const
 

Data Fields

std::vector< BatchItemitems
 
uint32_t batch_start_time {0}
 

Detailed Description

Definition at line 527 of file api_connection.h.

Constructor & Destructor Documentation

◆ DeferredBatch()

esphome::api::APIConnection::DeferredBatch::DeferredBatch ( )
inline

Definition at line 551 of file api_connection.h.

◆ ~DeferredBatch()

esphome::api::APIConnection::DeferredBatch::~DeferredBatch ( )
inline

Definition at line 556 of file api_connection.h.

Member Function Documentation

◆ add_item()

void esphome::api::APIConnection::DeferredBatch::add_item ( EntityBase * entity,
MessageCreator creator,
uint8_t message_type,
uint8_t estimated_size )

Definition at line 1644 of file api_connection.cpp.

◆ add_item_front()

void esphome::api::APIConnection::DeferredBatch::add_item_front ( EntityBase * entity,
MessageCreator creator,
uint8_t message_type,
uint8_t estimated_size )

Definition at line 1663 of file api_connection.cpp.

◆ clear()

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

Definition at line 567 of file api_connection.h.

◆ empty()

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

Definition at line 579 of file api_connection.h.

◆ operator[]()

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

Definition at line 581 of file api_connection.h.

◆ remove_front()

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

Definition at line 574 of file api_connection.h.

◆ size()

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

Definition at line 580 of file api_connection.h.

Field Documentation

◆ batch_start_time

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

Definition at line 540 of file api_connection.h.

◆ items

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

Definition at line 539 of file api_connection.h.


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