esphome::api::APIFrameHelper Class Reference

#include <api_frame_helper.h>

Inheritance diagram for esphome::api::APIFrameHelper:

Public Member Functions
virtual	~APIFrameHelper ()=default
virtual APIError	init ()=0
virtual APIError	loop ()=0
virtual APIError	read_packet (ReadPacketBuffer *buffer)=0
virtual bool	can_write_without_blocking ()=0
virtual APIError	write_packet (uint16_t type, const uint8_t *data, size_t len)=0
virtual std::string	getpeername ()=0
virtual int	getpeername (struct sockaddr *addr, socklen_t *addrlen)=0
virtual APIError	close ()=0
virtual APIError	shutdown (int how)=0
virtual void	set_log_info (std::string info)=0

Detailed Description

Definition at line 61 of file api_frame_helper.h.

Constructor & Destructor Documentation

~APIFrameHelper()

virtual esphome::api::APIFrameHelper::~APIFrameHelper ( )

virtualdefault

Member Function Documentation

can_write_without_blocking()

virtual bool esphome::api::APIFrameHelper::can_write_without_blocking ( )

pure virtual

Implemented in esphome::api::APIPlaintextFrameHelper, and esphome::api::APINoiseFrameHelper.

close()

virtual APIError esphome::api::APIFrameHelper::close ( )

pure virtual

Implemented in esphome::api::APIPlaintextFrameHelper, and esphome::api::APINoiseFrameHelper.

getpeername() [1/2]

virtual std::string esphome::api::APIFrameHelper::getpeername ( )

pure virtual

Implemented in esphome::api::APIPlaintextFrameHelper, and esphome::api::APINoiseFrameHelper.

getpeername() [2/2]

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

pure virtual

Implemented in esphome::api::APIPlaintextFrameHelper, and esphome::api::APINoiseFrameHelper.

init()

virtual APIError esphome::api::APIFrameHelper::init ( )

pure virtual

Implemented in esphome::api::APIPlaintextFrameHelper, and esphome::api::APINoiseFrameHelper.

loop()

virtual APIError esphome::api::APIFrameHelper::loop ( )

pure virtual

Implemented in esphome::api::APIPlaintextFrameHelper, and esphome::api::APINoiseFrameHelper.

read_packet()

virtual APIError esphome::api::APIFrameHelper::read_packet ( ReadPacketBuffer *  buffer )

pure virtual

Implemented in esphome::api::APIPlaintextFrameHelper, and esphome::api::APINoiseFrameHelper.

set_log_info()

virtual void esphome::api::APIFrameHelper::set_log_info ( std::string  info )

pure virtual

Implemented in esphome::api::APIPlaintextFrameHelper, and esphome::api::APINoiseFrameHelper.

shutdown()

virtual APIError esphome::api::APIFrameHelper::shutdown ( int  how )

pure virtual

Implemented in esphome::api::APIPlaintextFrameHelper, and esphome::api::APINoiseFrameHelper.

write_packet()

virtual APIError esphome::api::APIFrameHelper::write_packet ( uint16_t  type, const uint8_t *  data, size_t  len  )

pure virtual

Implemented in esphome::api::APIPlaintextFrameHelper, and esphome::api::APINoiseFrameHelper.

---

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

• /opt/build/esphome/esphome/components/api/api_frame_helper.h