#include <api_frame_helper.h>

Inheritance diagram for esphome::api::APIPlaintextFrameHelper:

Data Structures
struct	ParsedFrame

Public Member Functions
	APIPlaintextFrameHelper (std::unique_ptr< socket::Socket > socket)

	~APIPlaintextFrameHelper () override=default

APIError	init () override
	Initialize the frame helper, returns OK if successful.

APIError	loop () override
	Not used for plaintext.

APIError	read_packet (ReadPacketBuffer *buffer) override

bool	can_write_without_blocking () override

APIError	write_protobuf_packet (uint16_t type, ProtoWriteBuffer buffer) override

std::string	getpeername () override

int	getpeername (struct sockaddr addr, socklen_t addrlen) override

APIError	close () override

APIError	shutdown (int how) override

void	set_log_info (std::string info) override

uint8_t	frame_header_padding () override

uint8_t	frame_footer_size () override

Public Member Functions inherited from esphome::api::APIFrameHelper
virtual	~APIFrameHelper ()=default

Protected Types
enum class	State { INITIALIZE = 1 , DATA = 2 , CLOSED = 3 , FAILED = 4 }

Protected Member Functions
APIError	try_read_frame_ (ParsedFrame *frame)
	Read a packet into the rx_buf_.

APIError	try_send_tx_buf_ ()

APIError	write_raw_ (const struct iovec *iov, int iovcnt)

Protected Member Functions inherited from esphome::api::APIFrameHelper
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)

Protected Attributes
std::unique_ptr< socket::Socket >	socket_

std::string	info_

uint8_t	rx_header_buf_ [5]

uint8_t	rx_header_buf_pos_ = 0

bool	rx_header_parsed_ = false

uint32_t	rx_header_parsed_type_ = 0

uint32_t	rx_header_parsed_len_ = 0

std::vector< uint8_t >	rx_buf_

size_t	rx_buf_len_ = 0

std::vector< uint8_t >	tx_buf_

enum esphome::api::APIPlaintextFrameHelper::State	state_ = State::INITIALIZE

Protected Attributes inherited from esphome::api::APIFrameHelper
uint8_t	frame_header_padding_ {0}

uint8_t	frame_footer_size_ {0}

Detailed Description

Definition at line 173 of file api_frame_helper.h.

Member Enumeration Documentation

◆ State

enum class esphome::api::APIPlaintextFrameHelper::State

strongprotected

Enumerator
INITIALIZE
DATA
CLOSED
FAILED

Definition at line 235 of file api_frame_helper.h.

Constructor & Destructor Documentation

◆ APIPlaintextFrameHelper()

esphome::api::APIPlaintextFrameHelper::APIPlaintextFrameHelper ( std::unique_ptr< socket::Socket > socket )

inline

Definition at line 175 of file api_frame_helper.h.

◆ ~APIPlaintextFrameHelper()

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

overridedefault

Member Function Documentation

◆ can_write_without_blocking()

bool esphome::api::APIPlaintextFrameHelper::can_write_without_blocking ( )

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 1004 of file api_frame_helper.cpp.

◆ close()

APIError esphome::api::APIPlaintextFrameHelper::close ( )

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 1085 of file api_frame_helper.cpp.

◆ frame_footer_size()

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

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 200 of file api_frame_helper.h.

◆ frame_header_padding()

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

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 198 of file api_frame_helper.h.

◆ getpeername() [1/2]

std::string esphome::api::APIPlaintextFrameHelper::getpeername ( )

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 189 of file api_frame_helper.h.

◆ getpeername() [2/2]

int esphome::api::APIPlaintextFrameHelper::getpeername	(	struct sockaddr *	addr,
		socklen_t *	addrlen )

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 190 of file api_frame_helper.h.

◆ init()

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

overridevirtual

Initialize the frame helper, returns OK if successful.

Implements esphome::api::APIFrameHelper.

Definition at line 790 of file api_frame_helper.cpp.

◆ loop()

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

overridevirtual

Not used for plaintext.

Implements esphome::api::APIFrameHelper.

Definition at line 813 of file api_frame_helper.cpp.

◆ read_packet()

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

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 966 of file api_frame_helper.cpp.

◆ set_log_info()

void esphome::api::APIPlaintextFrameHelper::set_log_info ( std::string info )

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 196 of file api_frame_helper.h.

◆ shutdown()

APIError esphome::api::APIPlaintextFrameHelper::shutdown ( int how )

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 1092 of file api_frame_helper.cpp.

◆ try_read_frame_()

APIError esphome::api::APIPlaintextFrameHelper::try_read_frame_ ( ParsedFrame * 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 836 of file api_frame_helper.cpp.

◆ try_send_tx_buf_()

APIError esphome::api::APIPlaintextFrameHelper::try_send_tx_buf_ ( )

protected

Definition at line 1066 of file api_frame_helper.cpp.

◆ write_protobuf_packet()

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

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 1005 of file api_frame_helper.cpp.

◆ write_raw_()

APIError esphome::api::APIPlaintextFrameHelper::write_raw_	(	const struct iovec *	iov,
		int	iovcnt )

inlineprotected

Definition at line 209 of file api_frame_helper.h.

Field Documentation

◆ info_

std::string esphome::api::APIPlaintextFrameHelper::info_

protected

Definition at line 215 of file api_frame_helper.h.

◆ rx_buf_

std::vector<uint8_t> esphome::api::APIPlaintextFrameHelper::rx_buf_

protected

Definition at line 230 of file api_frame_helper.h.

◆ rx_buf_len_

size_t esphome::api::APIPlaintextFrameHelper::rx_buf_len_ = 0

protected

Definition at line 231 of file api_frame_helper.h.

◆ rx_header_buf_

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

protected

Definition at line 224 of file api_frame_helper.h.

◆ rx_header_buf_pos_

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

protected

Definition at line 225 of file api_frame_helper.h.

◆ rx_header_parsed_

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

protected

Definition at line 226 of file api_frame_helper.h.

◆ rx_header_parsed_len_

uint32_t esphome::api::APIPlaintextFrameHelper::rx_header_parsed_len_ = 0

protected

Definition at line 228 of file api_frame_helper.h.

◆ rx_header_parsed_type_

uint32_t esphome::api::APIPlaintextFrameHelper::rx_header_parsed_type_ = 0

protected

Definition at line 227 of file api_frame_helper.h.

◆ socket_

std::unique_ptr<socket::Socket> esphome::api::APIPlaintextFrameHelper::socket_

protected

Definition at line 213 of file api_frame_helper.h.

◆ state_

enum esphome::api::APIPlaintextFrameHelper::State esphome::api::APIPlaintextFrameHelper::state_ = State::INITIALIZE

protected

◆ tx_buf_

std::vector<uint8_t> esphome::api::APIPlaintextFrameHelper::tx_buf_

protected

Definition at line 233 of file api_frame_helper.h.

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

esphome/components/api/api_frame_helper.h
esphome/components/api/api_frame_helper.cpp

Data Structures

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ APIPlaintextFrameHelper()

◆ ~APIPlaintextFrameHelper()

Member Function Documentation

◆ can_write_without_blocking()

◆ close()

◆ frame_footer_size()

◆ frame_header_padding()

◆ getpeername() [1/2]

◆ getpeername() [2/2]

◆ init()

◆ loop()

◆ read_packet()

◆ set_log_info()

◆ shutdown()

◆ try_read_frame_()

◆ try_send_tx_buf_()

◆ write_protobuf_packet()

◆ write_raw_()

Field Documentation

◆ info_

◆ rx_buf_

◆ rx_buf_len_

◆ rx_header_buf_

◆ rx_header_buf_pos_

◆ rx_header_parsed_

◆ rx_header_parsed_len_

◆ rx_header_parsed_type_

◆ socket_

◆ state_

◆ tx_buf_