ESPHome 2026.6.0-dev
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes
esphome::network::IPAddress Struct Reference

#include <ip_address.h>

Public Member Functions

 IPAddress ()
 
 IPAddress (const std::string &in_address)
 
 IPAddress (const struct in6_addr *other_ip)
 
 IPAddress (const struct sockaddr_in6 *addr)
 
 operator struct in6_addr () const
 
bool is_set () const
 
bool is_ip4 () const
 
bool is_ip6 () const
 
bool is_multicast () const
 
 ESPDEPRECATED ("str() is deprecated: use 'char buf[IP_ADDRESS_BUFFER_SIZE]; ip.str_to(buf);' instead. Removed in 2026.8.0", "2026.2.0") std
 
 IPAddress (uint8_t first, uint8_t second, uint8_t third, uint8_t fourth)
 
 IPAddress (const std::string &in_address)
 
 IPAddress (const ip_addr_t *other_ip)
 
 ESPDEPRECATED ("str() is deprecated: use 'char buf[IP_ADDRESS_BUFFER_SIZE]; ip.str_to(buf);' instead. Removed in 2026.8.0", "2026.2.0") std
 
 IPAddress (uint8_t first, uint8_t second, uint8_t third, uint8_t fourth)
 
 IPAddress (const ip_addr_t *other_ip)
 
 IPAddress (const char *in_address)
 
 IPAddress (const std::string &in_address)
 
 IPAddress (ip4_addr_t *other_ip)
 
 IPAddress (const arduino_ns::IPAddress &other_ip)
 
 IPAddress (ip6_addr_t *other_ip)
 
 IPAddress (esp_ip6_addr_t *other_ip)
 
 IPAddress (esp_ip4_addr_t *other_ip)
 
 IPAddress (esp_ip_addr_t *other_ip)
 
 operator esp_ip_addr_t () const
 
 operator esp_ip4_addr_t () const
 
 operator ip_addr_t () const
 
 operator ip4_addr_t () const
 
 operator arduino_ns::IPAddress () const
 
bool is_set () const
 
bool is_ip4 () const
 
bool is_ip6 () const
 
bool is_multicast () const
 
 ESPDEPRECATED ("str() is deprecated: use 'char buf[IP_ADDRESS_BUFFER_SIZE]; ip.str_to(buf);' instead. Removed in 2026.8.0", "2026.2.0") std
 Write IP address to buffer.
 

Protected Attributes

ip_addr_t ip_addr_
 

Detailed Description

Definition at line 60 of file ip_address.h.

Constructor & Destructor Documentation

◆ IPAddress() [1/17]

esphome::network::IPAddress::IPAddress ( )
inline

Definition at line 63 of file ip_address.h.

◆ IPAddress() [2/17]

esphome::network::IPAddress::IPAddress ( const std::string & in_address)
inline

Definition at line 64 of file ip_address.h.

◆ IPAddress() [3/17]

esphome::network::IPAddress::IPAddress ( const struct in6_addr * other_ip)
inline

Definition at line 65 of file ip_address.h.

◆ IPAddress() [4/17]

esphome::network::IPAddress::IPAddress ( const struct sockaddr_in6 * addr)
inline

Definition at line 66 of file ip_address.h.

◆ IPAddress() [5/17]

esphome::network::IPAddress::IPAddress ( uint8_t first,
uint8_t second,
uint8_t third,
uint8_t fourth )
inline

Definition at line 93 of file ip_address.h.

◆ IPAddress() [6/17]

esphome::network::IPAddress::IPAddress ( const std::string & in_address)
inline

Definition at line 96 of file ip_address.h.

◆ IPAddress() [7/17]

esphome::network::IPAddress::IPAddress ( const ip_addr_t * other_ip)
inline

Definition at line 97 of file ip_address.h.

◆ IPAddress() [8/17]

esphome::network::IPAddress::IPAddress ( uint8_t first,
uint8_t second,
uint8_t third,
uint8_t fourth )
inline

Definition at line 114 of file ip_address.h.

◆ IPAddress() [9/17]

esphome::network::IPAddress::IPAddress ( const ip_addr_t * other_ip)
inline

Definition at line 117 of file ip_address.h.

◆ IPAddress() [10/17]

esphome::network::IPAddress::IPAddress ( const char * in_address)
inline

Definition at line 118 of file ip_address.h.

◆ IPAddress() [11/17]

esphome::network::IPAddress::IPAddress ( const std::string & in_address)
inline

Definition at line 119 of file ip_address.h.

◆ IPAddress() [12/17]

esphome::network::IPAddress::IPAddress ( ip4_addr_t * other_ip)
inline

Definition at line 120 of file ip_address.h.

◆ IPAddress() [13/17]

esphome::network::IPAddress::IPAddress ( const arduino_ns::IPAddress & other_ip)
inline

Definition at line 127 of file ip_address.h.

◆ IPAddress() [14/17]

esphome::network::IPAddress::IPAddress ( ip6_addr_t * other_ip)
inline

Definition at line 130 of file ip_address.h.

◆ IPAddress() [15/17]

esphome::network::IPAddress::IPAddress ( esp_ip6_addr_t * other_ip)
inline

Definition at line 138 of file ip_address.h.

◆ IPAddress() [16/17]

esphome::network::IPAddress::IPAddress ( esp_ip4_addr_t * other_ip)
inline

Definition at line 143 of file ip_address.h.

◆ IPAddress() [17/17]

esphome::network::IPAddress::IPAddress ( esp_ip_addr_t * other_ip)
inline

Definition at line 149 of file ip_address.h.

Member Function Documentation

◆ ESPDEPRECATED() [1/3]

esphome::network::IPAddress::ESPDEPRECATED ( "str() is deprecated: use 'char buf; ip.str_to(buf);' instead. Removed in 2026.8.0" [IP_ADDRESS_BUFFER_SIZE],
"2026.2.0"  )
inline

Definition at line 75 of file ip_address.h.

◆ ESPDEPRECATED() [2/3]

esphome::network::IPAddress::ESPDEPRECATED ( "str() is deprecated: use 'char buf; ip.str_to(buf);' instead. Removed in 2026.8.0" [IP_ADDRESS_BUFFER_SIZE],
"2026.2.0"  )
inline

Definition at line 99 of file ip_address.h.

◆ ESPDEPRECATED() [3/3]

esphome::network::IPAddress::ESPDEPRECATED ( "str() is deprecated: use 'char buf; ip.str_to(buf);' instead. Removed in 2026.8.0" [IP_ADDRESS_BUFFER_SIZE],
"2026.2.0"  )
inline

Write IP address to buffer.

Buffer must be at least IP_ADDRESS_BUFFER_SIZE bytes. Output is lowercased per RFC 5952 (IPv6 hex digits a-f).

Definition at line 190 of file ip_address.h.

◆ is_ip4() [1/2]

bool esphome::network::IPAddress::is_ip4 ( ) const
inline

Definition at line 71 of file ip_address.h.

◆ is_ip4() [2/2]

bool esphome::network::IPAddress::is_ip4 ( ) const
inline

Definition at line 186 of file ip_address.h.

◆ is_ip6() [1/2]

bool esphome::network::IPAddress::is_ip6 ( ) const
inline

Definition at line 72 of file ip_address.h.

◆ is_ip6() [2/2]

bool esphome::network::IPAddress::is_ip6 ( ) const
inline

Definition at line 187 of file ip_address.h.

◆ is_multicast() [1/2]

bool esphome::network::IPAddress::is_multicast ( ) const
inline

Definition at line 73 of file ip_address.h.

◆ is_multicast() [2/2]

bool esphome::network::IPAddress::is_multicast ( ) const
inline

Definition at line 188 of file ip_address.h.

◆ is_set() [1/2]

bool esphome::network::IPAddress::is_set ( ) const
inline

Definition at line 70 of file ip_address.h.

◆ is_set() [2/2]

bool esphome::network::IPAddress::is_set ( ) const
inline

Definition at line 185 of file ip_address.h.

◆ operator arduino_ns::IPAddress()

esphome::network::IPAddress::operator arduino_ns::IPAddress ( ) const
inline

Definition at line 182 of file ip_address.h.

◆ operator esp_ip4_addr_t()

esphome::network::IPAddress::operator esp_ip4_addr_t ( ) const
inline

Definition at line 165 of file ip_address.h.

◆ operator esp_ip_addr_t()

esphome::network::IPAddress::operator esp_ip_addr_t ( ) const
inline

Definition at line 156 of file ip_address.h.

◆ operator ip4_addr_t()

esphome::network::IPAddress::operator ip4_addr_t ( ) const
inline

Definition at line 178 of file ip_address.h.

◆ operator ip_addr_t()

esphome::network::IPAddress::operator ip_addr_t ( ) const
inline

Definition at line 176 of file ip_address.h.

◆ operator struct in6_addr()

esphome::network::IPAddress::operator struct in6_addr ( ) const
inline

Definition at line 68 of file ip_address.h.

Field Documentation

◆ ip_addr_

ip_addr_t esphome::network::IPAddress::ip_addr_
protected

Definition at line 220 of file ip_address.h.

The documentation for this struct was generated from the following file:
Generated by doxygen 1.12.0