esphome::socket::LWIPRawImpl Class Reference

Connected socket implementation for LWIP raw TCP. More...

#include <lwip_raw_tcp_impl.h>

Inheritance diagram for esphome::socket::LWIPRawImpl:

Public Member Functions
	~LWIPRawImpl ()
void	init (struct pbuf *initial_rx=nullptr, bool initial_rx_closed=false)
std::unique_ptr< LWIPRawImpl >	accept (struct sockaddr *, socklen_t *)
std::unique_ptr< LWIPRawImpl >	accept_loop_monitored (struct sockaddr *addr, socklen_t *addrlen)
int	listen (int)
int	connect (const struct sockaddr *addr, socklen_t addrlen)
	Non-blocking: returns -1/EINPROGRESS once the SYN is queued, see poll_connect().
ConnectPollResult	poll_connect (int &err_out) const
ssize_t	read (void *buf, size_t len)
ssize_t	readv (const struct iovec *iov, int iovcnt)
ssize_t	recvfrom (void *, size_t, sockaddr *, socklen_t *)
ssize_t	write (const void *buf, size_t len)
ssize_t	writev (const struct iovec *iov, int iovcnt)
ssize_t	sendto (const void *, size_t, int, const struct sockaddr *, socklen_t)
bool	ready () const
int	setblocking (bool blocking)
int	loop ()
err_t	recv_fn (struct pbuf *pb, err_t err)
	LWIPRawCommon (sa_family_t family, struct tcp_pcb *pcb)
	LWIPRawCommon (const LWIPRawCommon &)=delete
Public Member Functions inherited from esphome::socket::LWIPRawCommon
	LWIPRawCommon (sa_family_t family, struct tcp_pcb *pcb)
	~LWIPRawCommon ()
	LWIPRawCommon (const LWIPRawCommon &)=delete
LWIPRawCommon &	operator= (const LWIPRawCommon &)=delete
int	bind (const struct sockaddr *name, socklen_t addrlen)
int	close ()
int	shutdown (int how)
int	getpeername (struct sockaddr *name, socklen_t *addrlen)
int	getsockname (struct sockaddr *name, socklen_t *addrlen)
size_t	getpeername_to (std::span< char, SOCKADDR_STR_LEN > buf)
	Format peer address into a fixed-size buffer (no heap allocation)
size_t	getsockname_to (std::span< char, SOCKADDR_STR_LEN > buf)
	Format local address into a fixed-size buffer (no heap allocation)
int	getsockopt (int level, int optname, void *optval, socklen_t *optlen)
int	setsockopt (int level, int optname, const void *optval, socklen_t optlen)
int	get_fd () const

Static Public Member Functions
static void	s_err_fn (void *arg, err_t err)
static err_t	s_recv_fn (void *arg, struct tcp_pcb *pcb, struct pbuf *pb, err_t err)
static err_t	s_connected_fn (void *arg, struct tcp_pcb *pcb, err_t err)

Protected Member Functions
bool	waiting_for_data_ () const
void	wait_for_data_ ()
ssize_t	read_locked_ (void *buf, size_t len)
ssize_t	internal_write_ (const void *buf, size_t len)
int	internal_output_ ()
Protected Member Functions inherited from esphome::socket::LWIPRawCommon
int	ip2sockaddr_ (ip_addr_t *ip, uint16_t port, struct sockaddr *name, socklen_t *addrlen)
bool	sockaddr2ip_ (const struct sockaddr *name, socklen_t addrlen, ip_addr_t *ip, uint16_t *port, bool for_bind) const
	sockaddr of this socket's family to lwip address and port; false with errno on mismatch.

Protected Attributes
pbuf *	rx_buf_ = nullptr
size_t	rx_buf_offset_ = 0
bool	rx_closed_ = false
Protected Attributes inherited from esphome::socket::LWIPRawCommon
struct tcp_pcb *	pcb_
bool	nodelay_ = false
sa_family_t	family_ = 0
uint8_t	recv_timeout_cs_ = 0
uint8_t	connect_err_ = 0

Detailed Description

Connected socket implementation for LWIP raw TCP.

No virtual methods — callers always use the concrete type.

Definition at line 75 of file lwip_raw_tcp_impl.h.

Constructor & Destructor Documentation

~LWIPRawImpl()

esphome::socket::LWIPRawImpl::~LWIPRawImpl

(

)

Definition at line 313 of file lwip_raw_tcp_impl.cpp.

Member Function Documentation

accept()

std::unique_ptr< LWIPRawImpl > esphome::socket::LWIPRawImpl::accept ( struct sockaddr * , socklen_t *  )

inline

Definition at line 83 of file lwip_raw_tcp_impl.h.

accept_loop_monitored()

std::unique_ptr< LWIPRawImpl > esphome::socket::LWIPRawImpl::accept_loop_monitored ( struct sockaddr * addr, socklen_t * addrlen )

inline

Definition at line 87 of file lwip_raw_tcp_impl.h.

connect()

int esphome::socket::LWIPRawImpl::connect	(	const struct sockaddr *	addr,
		socklen_t	addrlen )

Non-blocking: returns -1/EINPROGRESS once the SYN is queued, see poll_connect().

addr must match the socket family; an IPv4 peer on AF_INET6 arrives v4-mapped.

Definition at line 365 of file lwip_raw_tcp_impl.cpp.

init()

void esphome::socket::LWIPRawImpl::init	(	struct pbuf *	initial_rx = nullptr,
		bool	initial_rx_closed = false )

Definition at line 325 of file lwip_raw_tcp_impl.cpp.

internal_output_()

int esphome::socket::LWIPRawImpl::internal_output_ ( )

protected

Definition at line 601 of file lwip_raw_tcp_impl.cpp.

internal_write_()

ssize_t esphome::socket::LWIPRawImpl::internal_write_ ( const void * buf, size_t len )

protected

Definition at line 568 of file lwip_raw_tcp_impl.cpp.

listen()

int esphome::socket::LWIPRawImpl::listen ( int )

inline

Definition at line 92 of file lwip_raw_tcp_impl.h.

loop()

int esphome::socket::LWIPRawImpl::loop ( )

inline

Definition at line 133 of file lwip_raw_tcp_impl.h.

LWIPRawCommon() [1/2]

esphome::socket::LWIPRawCommon::LWIPRawCommon ( const LWIPRawCommon & )

delete

LWIPRawCommon() [2/2]

esphome::socket::LWIPRawCommon::LWIPRawCommon ( sa_family_t family, struct tcp_pcb * pcb )

inline

Definition at line 29 of file lwip_raw_tcp_impl.h.

poll_connect()

ConnectPollResult esphome::socket::LWIPRawImpl::poll_connect

(

int &

err_out

)

const

Definition at line 393 of file lwip_raw_tcp_impl.cpp.

read()

ssize_t esphome::socket::LWIPRawImpl::read	(	void *	buf,
		size_t	len )

Definition at line 527 of file lwip_raw_tcp_impl.cpp.

read_locked_()

ssize_t esphome::socket::LWIPRawImpl::read_locked_ ( void * buf, size_t len )

protected

Definition at line 467 of file lwip_raw_tcp_impl.cpp.

readv()

ssize_t esphome::socket::LWIPRawImpl::readv	(	const struct iovec *	iov,
		int	iovcnt )

Definition at line 542 of file lwip_raw_tcp_impl.cpp.

ready()

bool esphome::socket::LWIPRawImpl::ready ( ) const

inline

Definition at line 120 of file lwip_raw_tcp_impl.h.

recv_fn()

err_t esphome::socket::LWIPRawImpl::recv_fn	(	struct pbuf *	pb,
		err_t	err )

Definition at line 421 of file lwip_raw_tcp_impl.cpp.

recvfrom()

ssize_t esphome::socket::LWIPRawImpl::recvfrom ( void * , size_t , sockaddr * , socklen_t *  )

inline

Definition at line 104 of file lwip_raw_tcp_impl.h.

s_connected_fn()

err_t esphome::socket::LWIPRawImpl::s_connected_fn ( void * arg, struct tcp_pcb * pcb, err_t err )

static

Definition at line 357 of file lwip_raw_tcp_impl.cpp.

s_err_fn()

void esphome::socket::LWIPRawImpl::s_err_fn ( void * arg, err_t err )

static

Definition at line 338 of file lwip_raw_tcp_impl.cpp.

s_recv_fn()

err_t esphome::socket::LWIPRawImpl::s_recv_fn ( void * arg, struct tcp_pcb * pcb, struct pbuf * pb, err_t err )

static

Definition at line 416 of file lwip_raw_tcp_impl.cpp.

sendto()

ssize_t esphome::socket::LWIPRawImpl::sendto ( const void * , size_t , int , const struct sockaddr * , socklen_t  )

inline

Definition at line 110 of file lwip_raw_tcp_impl.h.

setblocking()

int esphome::socket::LWIPRawImpl::setblocking ( bool blocking )

inline

Definition at line 124 of file lwip_raw_tcp_impl.h.

wait_for_data_()

void esphome::socket::LWIPRawImpl::wait_for_data_ ( )

protected

Definition at line 450 of file lwip_raw_tcp_impl.cpp.

waiting_for_data_()

bool esphome::socket::LWIPRawImpl::waiting_for_data_ ( ) const

inlineprotected

Definition at line 147 of file lwip_raw_tcp_impl.h.

write()

ssize_t esphome::socket::LWIPRawImpl::write	(	const void *	buf,
		size_t	len )

Definition at line 628 of file lwip_raw_tcp_impl.cpp.

writev()

ssize_t esphome::socket::LWIPRawImpl::writev	(	const struct iovec *	iov,
		int	iovcnt )

Definition at line 645 of file lwip_raw_tcp_impl.cpp.

Field Documentation

rx_buf_

pbuf* esphome::socket::LWIPRawImpl::rx_buf_ = nullptr

protected

Definition at line 153 of file lwip_raw_tcp_impl.h.

rx_buf_offset_

size_t esphome::socket::LWIPRawImpl::rx_buf_offset_ = 0

protected

Definition at line 154 of file lwip_raw_tcp_impl.h.

rx_closed_

bool esphome::socket::LWIPRawImpl::rx_closed_ = false

protected

Definition at line 155 of file lwip_raw_tcp_impl.h.

---

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

• esphome/components/socket/lwip_raw_tcp_impl.h
• esphome/components/socket/lwip_raw_tcp_impl.cpp