inet (Internet Addressing)

Overview

C++ utilities for the inet (Internet Addressing) module.

Provides C++ wrappers for IP addresses (IpAddr), socket addresses (SockAddr) and MAC addresses (MacAddr).

Data Structures
class	IpAddr
	A wrapper class for the EtcPal IP address type. More...
class	SockAddr
	A wrapper for the EtcPal socket address type. More...
class	MacAddr
	A wrapper for the EtcPal MAC address type. More...
class	NetintInfo
	A wrapper class for the EtcPal netint info type. More...

Typedefs
using	NetintIndex = etcpal::OpaqueId< detail::NetintIndexType, unsigned int, 0 >
	A handle that represents a network interface index. More...

Enumerations
enum class	IpAddrType { kInvalid = kEtcPalIpTypeInvalid , kV4 = kEtcPalIpTypeV4 , kV6 = kEtcPalIpTypeV6 }
	Indicates an IP address family, or an invalid IP address.

Inet Relational Operators
bool	operator== (const EtcPalIpAddr &c_ip, const IpAddr &ip) noexcept
bool	operator!= (const EtcPalIpAddr &c_ip, const IpAddr &ip) noexcept
bool	operator== (const IpAddr &ip, const EtcPalIpAddr &c_ip) noexcept
bool	operator!= (const IpAddr &ip, const EtcPalIpAddr &c_ip) noexcept
bool	operator== (const EtcPalSockAddr &c_ip, const SockAddr &ip) noexcept
bool	operator!= (const EtcPalSockAddr &c_ip, const SockAddr &ip) noexcept
bool	operator== (const SockAddr &ip, const EtcPalSockAddr &c_ip) noexcept
bool	operator!= (const SockAddr &ip, const EtcPalSockAddr &c_ip) noexcept
bool	operator== (const EtcPalMacAddr &c_mac, const MacAddr &mac) noexcept
bool	operator!= (const EtcPalMacAddr &c_mac, const MacAddr &mac) noexcept
bool	operator== (const MacAddr &mac, const EtcPalMacAddr &c_mac) noexcept
bool	operator!= (const MacAddr &mac, const EtcPalMacAddr &c_mac) noexcept
bool	operator== (const EtcPalNetintInfo &c_info, const NetintInfo &info) noexcept
bool	operator!= (const EtcPalNetintInfo &c_info, const NetintInfo &info) noexcept
bool	operator== (const NetintInfo &info, const EtcPalNetintInfo &c_info) noexcept
bool	operator!= (const NetintInfo &info, const EtcPalNetintInfo &c_info) noexcept
bool	operator== (const IpAddr &a, const IpAddr &b) noexcept
bool	operator!= (const IpAddr &a, const IpAddr &b) noexcept
bool	operator< (const IpAddr &a, const IpAddr &b) noexcept
bool	operator> (const IpAddr &a, const IpAddr &b) noexcept
bool	operator<= (const IpAddr &a, const IpAddr &b) noexcept
bool	operator>= (const IpAddr &a, const IpAddr &b) noexcept
bool	operator== (const SockAddr &a, const SockAddr &b) noexcept
bool	operator!= (const SockAddr &a, const SockAddr &b) noexcept
bool	operator< (const SockAddr &a, const SockAddr &b) noexcept
bool	operator> (const SockAddr &a, const SockAddr &b) noexcept
bool	operator<= (const SockAddr &a, const SockAddr &b) noexcept
bool	operator>= (const SockAddr &a, const SockAddr &b) noexcept
bool	operator== (const MacAddr &a, const MacAddr &b) noexcept
bool	operator!= (const MacAddr &a, const MacAddr &b) noexcept
bool	operator< (const MacAddr &a, const MacAddr &b) noexcept
bool	operator> (const MacAddr &a, const MacAddr &b) noexcept
bool	operator<= (const MacAddr &a, const MacAddr &b) noexcept
bool	operator>= (const MacAddr &a, const MacAddr &b) noexcept
bool	operator== (const NetintInfo &a, const NetintInfo &b) noexcept
bool	operator!= (const NetintInfo &a, const NetintInfo &b) noexcept
bool	operator< (const NetintInfo &a, const NetintInfo &b) noexcept
bool	operator> (const NetintInfo &a, const NetintInfo &b) noexcept
bool	operator<= (const NetintInfo &a, const NetintInfo &b) noexcept
bool	operator>= (const NetintInfo &a, const NetintInfo &b) noexcept

Typedef Documentation

NetintIndex

using NetintIndex = etcpal::OpaqueId<detail::NetintIndexType, unsigned int, 0>

A handle that represents a network interface index.

You can get the raw integer by calling value() on the handle, assuming it's valid.