Data Structures
class	Socket

Functions
std::unique_ptr< Socket >	socket (int domain, int type, int protocol)
	Create a socket of the given domain, type and protocol.

std::unique_ptr< Socket >	socket_loop_monitored (int domain, int type, int protocol)
	Create a socket and monitor it for data in the main loop.

void	socket_delay (uint32_t ms)
	Delay that can be woken early by socket activity.

void	socket_wake ()
	Called by lwip callbacks to signal socket activity and wake delay.

size_t	format_sockaddr_to (const struct sockaddr *addr_ptr, socklen_t len, std::span< char, SOCKADDR_STR_LEN > buf)
	Format sockaddr into caller-provided buffer, returns length written (excluding null)

std::unique_ptr< Socket >	socket_ip (int type, int protocol)
	Create a socket in the newest available IP domain (IPv6 or IPv4) of the given type and protocol.

std::unique_ptr< Socket >	socket_ip_loop_monitored (int type, int protocol)

socklen_t	set_sockaddr (struct sockaddr addr, socklen_t addrlen, const char ip_address, uint16_t port)
	Set a sockaddr to the specified address and port for the IP version used by socket_ip().

socklen_t	set_sockaddr_any (struct sockaddr *addr, socklen_t addrlen, uint16_t port)
	Set a sockaddr to the any address and specified port for the IP version used by socket_ip().

socklen_t	set_sockaddr (struct sockaddr *addr, socklen_t addrlen, const std::string &ip_address, uint16_t port)
	Convenience overload for std::string (backward compatible).

Function Documentation

◆ format_sockaddr_to()

size_t esphome::socket::format_sockaddr_to	(	const struct sockaddr *	addr_ptr,
		socklen_t	len,
		std::span< char, SOCKADDR_STR_LEN >	buf )

Format sockaddr into caller-provided buffer, returns length written (excluding null)

Definition at line 53 of file socket.cpp.

◆ set_sockaddr() [1/2]

socklen_t esphome::socket::set_sockaddr	(	struct sockaddr *	addr,
		socklen_t	addrlen,
		const char *	ip_address,
		uint16_t	port )

Set a sockaddr to the specified address and port for the IP version used by socket_ip().

Parameters

addr	Destination sockaddr structure
addrlen	Size of the addr buffer
ip_address	Null-terminated IP address string (IPv4 or IPv6)
port	Port number in host byte order

Returns: Size of the sockaddr structure used, or 0 on error

Definition at line 120 of file socket.cpp.

◆ set_sockaddr() [2/2]

socklen_t esphome::socket::set_sockaddr	(	struct sockaddr *	addr,
		socklen_t	addrlen,
		const std::string &	ip_address,
		uint16_t	port )

inline

Convenience overload for std::string (backward compatible).

Definition at line 114 of file socket.h.

◆ set_sockaddr_any()

socklen_t esphome::socket::set_sockaddr_any	(	struct sockaddr *	addr,
		socklen_t	addrlen,
		uint16_t	port )

Set a sockaddr to the any address and specified port for the IP version used by socket_ip().

Definition at line 159 of file socket.cpp.

◆ socket()

std::unique_ptr< Socket > esphome::socket::socket	(	int	domain,
		int	type,
		int	protocol )

Create a socket of the given domain, type and protocol.

Definition at line 135 of file bsd_sockets_impl.cpp.

◆ socket_delay()

void esphome::socket::socket_delay ( uint32_t ms )

Delay that can be woken early by socket activity.

On ESP8266, lwip callbacks set a flag and call esp_schedule() to wake the delay.

Definition at line 28 of file lwip_raw_tcp_impl.cpp.

◆ socket_ip()

std::unique_ptr< Socket > esphome::socket::socket_ip	(	int	type,
		int	protocol )

Create a socket in the newest available IP domain (IPv6 or IPv4) of the given type and protocol.

Definition at line 104 of file socket.cpp.

◆ socket_ip_loop_monitored()

std::unique_ptr< Socket > esphome::socket::socket_ip_loop_monitored	(	int	type,
		int	protocol )

Definition at line 112 of file socket.cpp.

◆ socket_loop_monitored()

std::unique_ptr< Socket > esphome::socket::socket_loop_monitored	(	int	domain,
		int	type,
		int	protocol )

Create a socket and monitor it for data in the main loop.

Like socket() but also registers the socket with the Application's select() loop. WARNING: These functions are NOT thread-safe. They must only be called from the main loop as they register the socket file descriptor with the global Application instance. NOTE: On ESP platforms, FD_SETSIZE is typically 10, limiting the number of monitored sockets. File descriptors >= FD_SETSIZE will not be monitored and will log an error.

Definition at line 139 of file bsd_sockets_impl.cpp.

◆ socket_wake()

void esphome::socket::socket_wake ( )

Called by lwip callbacks to signal socket activity and wake delay.

Definition at line 44 of file lwip_raw_tcp_impl.cpp.

Data Structures

Functions