#include <api_frame_helper.h>

Inheritance diagram for esphome::api::APINoiseFrameHelper:

Data Structures
struct	ParsedFrame

Public Member Functions
	APINoiseFrameHelper (std::unique_ptr< socket::Socket > socket, std::shared_ptr< APINoiseContext > ctx)

	~APINoiseFrameHelper () override

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

APIError	loop () override
	Run through handshake messages (if in that phase)

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 , CLIENT_HELLO = 2 , SERVER_HELLO = 3 , HANDSHAKE = 4 , DATA = 5 , CLOSED = 6 , FAILED = 7 , EXPLICIT_REJECT = 8 }

Protected Member Functions
APIError	state_action_ ()
	To be called from read/write methods.

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

APIError	try_send_tx_buf_ ()

APIError	write_frame_ (const uint8_t *data, size_t len)

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

APIError	init_handshake_ ()
	Initiate the data structures for the handshake.

APIError	check_handshake_finished_ ()

void	send_explicit_handshake_reject_ (const std::string &reason)

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_ [3]

size_t	rx_header_buf_len_ = 0

std::vector< uint8_t >	rx_buf_

size_t	rx_buf_len_ = 0

std::vector< uint8_t >	tx_buf_

std::vector< uint8_t >	prologue_

std::shared_ptr< APINoiseContext >	ctx_

NoiseHandshakeState *	handshake_ {nullptr}

NoiseCipherState *	send_cipher_ {nullptr}

NoiseCipherState *	recv_cipher_ {nullptr}

NoiseProtocolId	nid_

enum esphome::api::APINoiseFrameHelper::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 93 of file api_frame_helper.h.

Member Enumeration Documentation

◆ State

enum class esphome::api::APINoiseFrameHelper::State

strongprotected

Enumerator
INITIALIZE
CLIENT_HELLO
SERVER_HELLO
HANDSHAKE
DATA
CLOSED
FAILED
EXPLICIT_REJECT

Definition at line 159 of file api_frame_helper.h.

Constructor & Destructor Documentation

◆ APINoiseFrameHelper()

esphome::api::APINoiseFrameHelper::APINoiseFrameHelper	(	std::unique_ptr< socket::Socket >	socket,
		std::shared_ptr< APINoiseContext >	ctx )

inline

Definition at line 95 of file api_frame_helper.h.

◆ ~APINoiseFrameHelper()

esphome::api::APINoiseFrameHelper::~APINoiseFrameHelper ( )

override

Definition at line 740 of file api_frame_helper.cpp.

Member Function Documentation

◆ can_write_without_blocking()

bool esphome::api::APINoiseFrameHelper::can_write_without_blocking ( )

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 562 of file api_frame_helper.cpp.

◆ check_handshake_finished_()

APIError esphome::api::APINoiseFrameHelper::check_handshake_finished_ ( )

protected

Definition at line 713 of file api_frame_helper.cpp.

◆ close()

APIError esphome::api::APINoiseFrameHelper::close ( )

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 755 of file api_frame_helper.cpp.

◆ frame_footer_size()

uint8_t esphome::api::APINoiseFrameHelper::frame_footer_size ( )

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 121 of file api_frame_helper.h.

◆ frame_header_padding()

uint8_t esphome::api::APINoiseFrameHelper::frame_header_padding ( )

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 119 of file api_frame_helper.h.

◆ getpeername() [1/2]

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

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 110 of file api_frame_helper.h.

◆ getpeername() [2/2]

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

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 111 of file api_frame_helper.h.

◆ init()

APIError esphome::api::APINoiseFrameHelper::init ( )

overridevirtual

Initialize the frame helper, returns OK if successful.

Implements esphome::api::APIFrameHelper.

Definition at line 208 of file api_frame_helper.cpp.

◆ init_handshake_()

APIError esphome::api::APINoiseFrameHelper::init_handshake_ ( )

protected

Initiate the data structures for the handshake.

Returns: 0 on success, -1 on error (check errno)

Definition at line 667 of file api_frame_helper.cpp.

◆ loop()

APIError esphome::api::APINoiseFrameHelper::loop ( )

overridevirtual

Run through handshake messages (if in that phase)

Implements esphome::api::APIFrameHelper.

Definition at line 235 of file api_frame_helper.cpp.

◆ read_packet()

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

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 509 of file api_frame_helper.cpp.

◆ send_explicit_handshake_reject_()

void esphome::api::APINoiseFrameHelper::send_explicit_handshake_reject_ ( const std::string & reason )

protected

Definition at line 492 of file api_frame_helper.cpp.

◆ set_log_info()

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

inlineoverridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 117 of file api_frame_helper.h.

◆ shutdown()

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

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 762 of file api_frame_helper.cpp.

◆ state_action_()

APIError esphome::api::APINoiseFrameHelper::state_action_ ( )

protected

To be called from read/write methods.

This method runs through the internal handshake methods, if in that state.

If the handshake is still active when this method returns and a read/write can't take place at the moment, returns WOULD_BLOCK. If an error occurred, returns that error. Only returns OK if the transport is ready for data traffic.

Definition at line 362 of file api_frame_helper.cpp.

◆ try_read_frame_()

APIError esphome::api::APINoiseFrameHelper::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_start: points to the start of the payload - this pointer is only valid until the next try_receive_raw_ call

Returns: 0 if a full packet is in rx_buf_; -1 if error, check errno.

errno EWOULDBLOCK: Packet could not be read without blocking. Try again later. errno ENOMEM: Not enough memory for reading packet. errno API_ERROR_BAD_INDICATOR: Bad indicator byte at start of frame. errno API_ERROR_HANDSHAKE_PACKET_LEN: Packet too big for this phase.

Definition at line 264 of file api_frame_helper.cpp.

◆ try_send_tx_buf_()

APIError esphome::api::APINoiseFrameHelper::try_send_tx_buf_ ( )

protected

Definition at line 625 of file api_frame_helper.cpp.

◆ write_frame_()

APIError esphome::api::APINoiseFrameHelper::write_frame_	(	const uint8_t *	data,
		size_t	len )

protected

Definition at line 645 of file api_frame_helper.cpp.

◆ write_protobuf_packet()

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

overridevirtual

Implements esphome::api::APIFrameHelper.

Definition at line 563 of file api_frame_helper.cpp.

◆ write_raw_()

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

inlineprotected

Definition at line 132 of file api_frame_helper.h.

Field Documentation

◆ ctx_

std::shared_ptr<APINoiseContext> esphome::api::APINoiseFrameHelper::ctx_

protected

Definition at line 153 of file api_frame_helper.h.

◆ handshake_

NoiseHandshakeState* esphome::api::APINoiseFrameHelper::handshake_ {nullptr}

protected

Definition at line 154 of file api_frame_helper.h.

◆ info_

std::string esphome::api::APINoiseFrameHelper::info_

protected

Definition at line 141 of file api_frame_helper.h.

◆ nid_

NoiseProtocolId esphome::api::APINoiseFrameHelper::nid_

protected

Definition at line 157 of file api_frame_helper.h.

◆ prologue_

std::vector<uint8_t> esphome::api::APINoiseFrameHelper::prologue_

protected

Definition at line 151 of file api_frame_helper.h.

◆ recv_cipher_

NoiseCipherState* esphome::api::APINoiseFrameHelper::recv_cipher_ {nullptr}

protected

Definition at line 156 of file api_frame_helper.h.

◆ rx_buf_

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

protected

Definition at line 147 of file api_frame_helper.h.

◆ rx_buf_len_

size_t esphome::api::APINoiseFrameHelper::rx_buf_len_ = 0

protected

Definition at line 148 of file api_frame_helper.h.

◆ rx_header_buf_

uint8_t esphome::api::APINoiseFrameHelper::rx_header_buf_[3]

protected

Definition at line 145 of file api_frame_helper.h.

◆ rx_header_buf_len_

size_t esphome::api::APINoiseFrameHelper::rx_header_buf_len_ = 0

protected

Definition at line 146 of file api_frame_helper.h.

◆ send_cipher_

NoiseCipherState* esphome::api::APINoiseFrameHelper::send_cipher_ {nullptr}

protected

Definition at line 155 of file api_frame_helper.h.

◆ socket_

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

protected

Definition at line 139 of file api_frame_helper.h.

◆ state_

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

protected

◆ tx_buf_

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

protected

Definition at line 150 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

◆ APINoiseFrameHelper()

◆ ~APINoiseFrameHelper()

Member Function Documentation

◆ can_write_without_blocking()

◆ check_handshake_finished_()

◆ close()

◆ frame_footer_size()

◆ frame_header_padding()

◆ getpeername() [1/2]

◆ getpeername() [2/2]

◆ init()

◆ init_handshake_()

◆ loop()

◆ read_packet()

◆ send_explicit_handshake_reject_()

◆ set_log_info()

◆ shutdown()

◆ state_action_()

◆ try_read_frame_()

◆ try_send_tx_buf_()

◆ write_frame_()

◆ write_protobuf_packet()

◆ write_raw_()

Field Documentation

◆ ctx_

◆ handshake_

◆ info_

◆ nid_

◆ prologue_

◆ recv_cipher_

◆ rx_buf_

◆ rx_buf_len_

◆ rx_header_buf_

◆ rx_header_buf_len_

◆ send_cipher_

◆ socket_

◆ state_

◆ tx_buf_