esphome::api::APIPlaintextFrameHelper Class Reference

#include <api_frame_helper_plaintext.h>

Inheritance diagram for esphome::api::APIPlaintextFrameHelper:

Public Member Functions
	APIPlaintextFrameHelper (std::unique_ptr< socket::Socket > socket, const ClientInfo *client_info)
	~APIPlaintextFrameHelper () override=default
APIError	init () override
	Initialize the frame helper, returns OK if successful.
APIError	loop () override
APIError	read_packet (ReadPacketBuffer *buffer) override
APIError	write_protobuf_packet (uint8_t type, ProtoWriteBuffer buffer) override
APIError	write_protobuf_packets (ProtoWriteBuffer buffer, std::span< const PacketInfo > packets) override
uint8_t	frame_header_padding () override
uint8_t	frame_footer_size () override
Public Member Functions inherited from esphome::api::APIFrameHelper
	APIFrameHelper ()=default
	APIFrameHelper (std::unique_ptr< socket::Socket > socket, const ClientInfo *client_info)
virtual	~APIFrameHelper ()=default
bool	can_write_without_blocking ()
std::string	getpeername ()
int	getpeername (struct sockaddr *addr, socklen_t *addrlen)
APIError	close ()
APIError	shutdown (int how)
bool	is_socket_ready () const

Protected Member Functions
APIError	try_read_frame_ (std::vector< uint8_t > *frame)
	Read a packet into the rx_buf_.
Protected Member Functions inherited from esphome::api::APIFrameHelper
APIError	write_raw_ (const struct iovec *iov, int iovcnt, uint16_t total_write_len)
APIError	try_send_tx_buf_ ()
void	buffer_data_from_iov_ (const struct iovec *iov, int iovcnt, uint16_t total_write_len, uint16_t offset)
APIError	handle_socket_write_error_ ()
template<typename StateEnum >
APIError	write_raw_ (const struct iovec *iov, int iovcnt, socket::Socket *socket, std::vector< uint8_t > &tx_buf, const std::string &info, StateEnum &state, StateEnum failed_state)
APIError	init_common_ ()
APIError	handle_socket_read_result_ (ssize_t received)

Protected Attributes
uint16_t	rx_header_parsed_type_ = 0
uint16_t	rx_header_parsed_len_ = 0
uint8_t	rx_header_buf_ [6]
uint8_t	rx_header_buf_pos_ = 0
bool	rx_header_parsed_ = false
Protected Attributes inherited from esphome::api::APIFrameHelper
socket::Socket *	socket_ {nullptr}
std::unique_ptr< socket::Socket >	socket_owned_
std::deque< SendBuffer >	tx_buf_
std::vector< struct iovec >	reusable_iovs_
std::vector< uint8_t >	rx_buf_
const ClientInfo *	client_info_ {nullptr}
uint16_t	rx_buf_len_ = 0
State	state_ {State::INITIALIZE}
uint8_t	frame_header_padding_ {0}
uint8_t	frame_footer_size_ {0}

Additional Inherited Members
Protected Types inherited from esphome::api::APIFrameHelper
enum class	State : uint8_t {   INITIALIZE = 1 , CLIENT_HELLO = 2 , SERVER_HELLO = 3 , HANDSHAKE = 4 ,   DATA = 5 , CLOSED = 6 , FAILED = 7 , EXPLICIT_REJECT = 8 }

Detailed Description

Definition at line 8 of file api_frame_helper_plaintext.h.

Constructor & Destructor Documentation

APIPlaintextFrameHelper()

esphome::api::APIPlaintextFrameHelper::APIPlaintextFrameHelper ( std::unique_ptr< socket::Socket > socket, const ClientInfo * client_info )

inline

Definition at line 10 of file api_frame_helper_plaintext.h.

~APIPlaintextFrameHelper()

esphome::api::APIPlaintextFrameHelper::~APIPlaintextFrameHelper ( )

overridedefault

Member Function Documentation

frame_footer_size()

uint8_t esphome::api::APIPlaintextFrameHelper::frame_footer_size ( )

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 27 of file api_frame_helper_plaintext.h.

frame_header_padding()

uint8_t esphome::api::APIPlaintextFrameHelper::frame_header_padding ( )

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 25 of file api_frame_helper_plaintext.h.

init()

APIError esphome::api::APIPlaintextFrameHelper::init ( )

overridevirtual

Initialize the frame helper, returns OK if successful.

Implements esphome::api::APIFrameHelper.

Definition at line 28 of file api_frame_helper_plaintext.cpp.

loop()

APIError esphome::api::APIPlaintextFrameHelper::loop ( )

overridevirtual

Reimplemented from esphome::api::APIFrameHelper.

Definition at line 37 of file api_frame_helper_plaintext.cpp.

read_packet()

APIError esphome::api::APIPlaintextFrameHelper::read_packet ( ReadPacketBuffer * buffer )

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 177 of file api_frame_helper_plaintext.cpp.

try_read_frame_()

APIError esphome::api::APIPlaintextFrameHelper::try_read_frame_ ( std::vector< uint8_t > * frame )

protected

Read a packet into the rx_buf_.

If successful, stores frame data in the frame parameter

Parameters

frame

The struct to hold the frame information in. msg: store the parsed frame in that struct

Returns

See APIError

error API_ERROR_BAD_INDICATOR: Bad indicator byte at start of frame.

Definition at line 54 of file api_frame_helper_plaintext.cpp.

write_protobuf_packet()

APIError esphome::api::APIPlaintextFrameHelper::write_protobuf_packet ( uint8_t type, ProtoWriteBuffer buffer )

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 215 of file api_frame_helper_plaintext.cpp.

write_protobuf_packets()

APIError esphome::api::APIPlaintextFrameHelper::write_protobuf_packets ( ProtoWriteBuffer buffer, std::span< const PacketInfo > packets )

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 220 of file api_frame_helper_plaintext.cpp.

Field Documentation

rx_header_buf_

uint8_t esphome::api::APIPlaintextFrameHelper::rx_header_buf_[6]

protected

Definition at line 45 of file api_frame_helper_plaintext.h.

rx_header_buf_pos_

uint8_t esphome::api::APIPlaintextFrameHelper::rx_header_buf_pos_ = 0

protected

Definition at line 46 of file api_frame_helper_plaintext.h.

rx_header_parsed_

bool esphome::api::APIPlaintextFrameHelper::rx_header_parsed_ = false

protected

Definition at line 47 of file api_frame_helper_plaintext.h.

rx_header_parsed_len_

uint16_t esphome::api::APIPlaintextFrameHelper::rx_header_parsed_len_ = 0

protected

Definition at line 34 of file api_frame_helper_plaintext.h.

rx_header_parsed_type_

uint16_t esphome::api::APIPlaintextFrameHelper::rx_header_parsed_type_ = 0

protected

Definition at line 33 of file api_frame_helper_plaintext.h.

---

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

• esphome/components/api/api_frame_helper_plaintext.h
• esphome/components/api/api_frame_helper_plaintext.cpp