esphome::api::ProtoService Class Reference

#include <proto.h>

Inheritance diagram for esphome::api::ProtoService:

Protected Member Functions
virtual bool	is_authenticated ()=0
virtual bool	is_connection_setup ()=0
virtual void	on_fatal_error ()=0
virtual void	on_unauthenticated_access ()=0
virtual void	on_no_setup_connection ()=0
virtual ProtoWriteBuffer	create_buffer (uint32_t reserve_size)=0
	Create a buffer with a reserved size.
virtual bool	send_buffer (ProtoWriteBuffer buffer, uint32_t message_type)=0
virtual bool	read_message (uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data)=0
template<class C >
bool	send_message_ (const C &msg, uint32_t message_type)

Detailed Description

Definition at line 346 of file proto.h.

Member Function Documentation

create_buffer()

virtual ProtoWriteBuffer esphome::api::ProtoService::create_buffer ( uint32_t reserve_size )

protectedpure virtual

Create a buffer with a reserved size.

Parameters

reserve_size

The number of bytes to pre-allocate in the buffer. This is a hint to optimize memory usage and avoid reallocations during encoding. Implementations should aim to allocate at least this size.

Returns

A ProtoWriteBuffer object with the reserved size.

Implemented in esphome::api::APIConnection.

is_authenticated()

virtual bool esphome::api::ProtoService::is_authenticated ( )

protectedpure virtual

Implemented in esphome::api::APIConnection.

is_connection_setup()

virtual bool esphome::api::ProtoService::is_connection_setup ( )

protectedpure virtual

Implemented in esphome::api::APIConnection.

on_fatal_error()

virtual void esphome::api::ProtoService::on_fatal_error ( )

protectedpure virtual

Implemented in esphome::api::APIConnection.

on_no_setup_connection()

virtual void esphome::api::ProtoService::on_no_setup_connection ( )

protectedpure virtual

Implemented in esphome::api::APIConnection.

on_unauthenticated_access()

virtual void esphome::api::ProtoService::on_unauthenticated_access ( )

protectedpure virtual

Implemented in esphome::api::APIConnection.

read_message()

virtual bool esphome::api::ProtoService::read_message ( uint32_t msg_size, uint32_t msg_type, uint8_t * msg_data )

protectedpure virtual

Implemented in esphome::api::APIServerConnectionBase.

send_buffer()

virtual bool esphome::api::ProtoService::send_buffer ( ProtoWriteBuffer buffer, uint32_t message_type )

protectedpure virtual

Implemented in esphome::api::APIConnection.

send_message_()

template<class C >

bool esphome::api::ProtoService::send_message_ ( const C & msg, uint32_t message_type )

inlineprotected

Definition at line 366 of file proto.h.

---

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

• esphome/components/api/proto.h