ESPHome  2024.6.6
Public Member Functions
esphome::api::APIFrameHelper Class Referenceabstract

#include <api_frame_helper.h>

Inheritance diagram for esphome::api::APIFrameHelper:
esphome::api::APINoiseFrameHelper esphome::api::APIPlaintextFrameHelper

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 ( )

Member Function Documentation

◆ can_write_without_blocking()

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

◆ close()

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

◆ getpeername() [1/2]

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

◆ getpeername() [2/2]

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

◆ init()

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

◆ loop()

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

◆ read_packet()

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

◆ set_log_info()

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

◆ shutdown()

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

◆ write_packet()

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

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