cosmos::InterfaceAddress Class Reference

A single network interface address. More...

#include <InterfaceAddress.hxx>

Inheritance diagram for cosmos::InterfaceAddress:

Public Member Functions
	InterfaceAddress (const InterfaceAddress &)=delete
SysString	ifname () const
	Returns the unique string that identifies the network device that this address belongs to.
InterfaceFlags	flags () const
	Returns the current interface status flags.
SocketFamily	family () const
	Returns the SocketFamily this address is about.
bool	hasAddress () const
	Returns whether an address is available in this entry.
bool	hasNetmask () const
	Returns whether a netmask address is available in this entry.
bool	hasBroadcastAddress () const
	Returns whether a broadcast address is available in this entry.
bool	hasPointToPointDest () const
	Returns whether a point-to-point destination is available in this entry.
bool	isIP4 () const
	Returns whether the interface address is an IPv4 address.
bool	isIP6 () const
	Returns whether the interface address is an IPv6 address.
bool	isLinkLayer () const
	Returns whether the interface address is a LinkLayerAddress.
std::optional< cosmos::IP4Address >	addrAsIP4 () const
	If this is an IPv4 address, return it.
std::optional< cosmos::IP6Address >	addrAsIP6 () const
	If this is an IPv6 address, return it.
std::optional< cosmos::LinkLayerAddress >	addrAsLLA () const
	If this is a link layer address, return it.
std::optional< cosmos::IP4Address >	netmaskAsIP4 () const
	If an IPv4 netmask is available, return it.
std::optional< cosmos::IP6Address >	netmaskAsIP6 () const
	If an IPv6 netmask is available, return it.
std::optional< cosmos::IP4Address >	broadcastAsIP4 () const
	If an IPv4 broadcast address is available, return it.
std::optional< cosmos::IP4Address >	pointToPointAsIP4 () const
	If an IPv4 point-to-point destination is available, return it.

Detailed Description

A single network interface address.

Instances of this type can be obtained from InterfaceAddressList. The type describes a single local network interface address of a specific SocketFamily. Typically each network interface supports multiple families like IPv4/IPv6 and also lower level families like packet socket addresses (Ethernet level).

Depending on the SocketFamily of the address and whether an address is actually assigned to the network interface, some of the addresses might be unavailable. Various functions like hasAddress() need to be used to determine whether a certain kind of interface address is stored at all.

Definition at line 67 of file InterfaceAddress.hxx.

Member Function Documentation

addrAsIP4()

std::optional< cosmos::IP4Address > cosmos::InterfaceAddress::addrAsIP4 ( ) const

inline

If this is an IPv4 address, return it.

Definition at line 146 of file InterfaceAddress.hxx.

                                                        {
                if (!isIP4())
                        return std::nullopt;
 
                return cosmos::IP4Address{*(reinterpret_cast<sockaddr_in*>(ifa_addr))};
        }

addrAsIP6()

std::optional< cosmos::IP6Address > cosmos::InterfaceAddress::addrAsIP6 ( ) const

inline

If this is an IPv6 address, return it.

Definition at line 154 of file InterfaceAddress.hxx.

                                                        {
                if (!isIP6())
                        return std::nullopt;
 
                return cosmos::IP6Address{*(reinterpret_cast<sockaddr_in6*>(ifa_addr))};
        }

addrAsLLA()

std::optional< cosmos::LinkLayerAddress > cosmos::InterfaceAddress::addrAsLLA ( ) const

inline

If this is a link layer address, return it.

Definition at line 162 of file InterfaceAddress.hxx.

                                                              {
                if (!isLinkLayer())
                        return std::nullopt;
 
                return cosmos::LinkLayerAddress{*(reinterpret_cast<sockaddr_ll*>(ifa_addr))};
        }

broadcastAsIP4()

std::optional< cosmos::IP4Address > cosmos::InterfaceAddress::broadcastAsIP4 ( ) const

inline

If an IPv4 broadcast address is available, return it.

Definition at line 186 of file InterfaceAddress.hxx.

                                                             {
                if (!hasBroadcastAddress() || SocketFamily{ifa_broadaddr->sa_family} != SocketFamily::INET)
                        return std::nullopt;
 
                return cosmos::IP4Address{*(reinterpret_cast<sockaddr_in*>(ifa_broadaddr))};
        }

family()

SocketFamily cosmos::InterfaceAddress::family ( ) const

inline

Returns the SocketFamily this address is about.

If no address is stored in this entry then SocketFamily::UNSPEC is returned here.

Definition at line 93 of file InterfaceAddress.hxx.

                                    {
                if (!hasAddress())
                        return SocketFamily::UNSPEC;
 
                return SocketFamily{ifa_addr->sa_family};
        }

flags()

InterfaceFlags cosmos::InterfaceAddress::flags ( ) const

inline

Returns the current interface status flags.

Definition at line 84 of file InterfaceAddress.hxx.

                                     {
                return InterfaceFlags{ifa_flags};
        }

hasAddress()

bool cosmos::InterfaceAddress::hasAddress ( ) const

inline

Returns whether an address is available in this entry.

Definition at line 101 of file InterfaceAddress.hxx.

                                {
                return ifa_addr != nullptr;
        }

hasBroadcastAddress()

bool cosmos::InterfaceAddress::hasBroadcastAddress ( ) const

inline

Returns whether a broadcast address is available in this entry.

A broadcast address is only available for IPv4 SocketFamily::INET sockets.

Definition at line 115 of file InterfaceAddress.hxx.

                                         {
                if (!flags()[InterfaceFlag::BROADCAST])
                        return false;
 
                return ifa_broadaddr != nullptr;
        }

hasNetmask()

bool cosmos::InterfaceAddress::hasNetmask ( ) const

inline

Returns whether a netmask address is available in this entry.

Definition at line 106 of file InterfaceAddress.hxx.

                                {
                return ifa_netmask != nullptr;
        }

hasPointToPointDest()

bool cosmos::InterfaceAddress::hasPointToPointDest ( ) const

inline

Returns whether a point-to-point destination is available in this entry.

Definition at line 123 of file InterfaceAddress.hxx.

                                         {
                if (!flags()[InterfaceFlag::POINTOPOINT])
                        return false;
 
                return ifa_dstaddr != nullptr;
        }

ifname()

SysString cosmos::InterfaceAddress::ifname ( ) const

inline

Returns the unique string that identifies the network device that this address belongs to.

Definition at line 79 of file InterfaceAddress.hxx.

                                 {
                return ifa_name;
        }

isIP4()

bool cosmos::InterfaceAddress::isIP4 ( ) const

inline

Returns whether the interface address is an IPv4 address.

Definition at line 131 of file InterfaceAddress.hxx.

                           {
                return family() == SocketFamily::INET;
        }

isIP6()

bool cosmos::InterfaceAddress::isIP6 ( ) const

inline

Returns whether the interface address is an IPv6 address.

Definition at line 136 of file InterfaceAddress.hxx.

                           {
                return family() == SocketFamily::INET6;
        }

isLinkLayer()

bool cosmos::InterfaceAddress::isLinkLayer ( ) const

inline

Returns whether the interface address is a LinkLayerAddress.

Definition at line 141 of file InterfaceAddress.hxx.

                                 {
                return family() == SocketFamily::PACKET;
        }

netmaskAsIP4()

std::optional< cosmos::IP4Address > cosmos::InterfaceAddress::netmaskAsIP4 ( ) const

inline

If an IPv4 netmask is available, return it.

Definition at line 170 of file InterfaceAddress.hxx.

                                                           {
                if (!hasNetmask() || SocketFamily{ifa_netmask->sa_family} != SocketFamily::INET)
                        return std::nullopt;
 
                return cosmos::IP4Address{*(reinterpret_cast<sockaddr_in*>(ifa_netmask))};
        }

netmaskAsIP6()

std::optional< cosmos::IP6Address > cosmos::InterfaceAddress::netmaskAsIP6 ( ) const

inline

If an IPv6 netmask is available, return it.

Definition at line 178 of file InterfaceAddress.hxx.

                                                           {
                if (!hasNetmask() || SocketFamily{ifa_netmask->sa_family} != SocketFamily::INET6)
                        return std::nullopt;
 
                return cosmos::IP6Address{*(reinterpret_cast<sockaddr_in6*>(ifa_netmask))};
        }

pointToPointAsIP4()

std::optional< cosmos::IP4Address > cosmos::InterfaceAddress::pointToPointAsIP4 ( ) const

inline

If an IPv4 point-to-point destination is available, return it.

Definition at line 194 of file InterfaceAddress.hxx.

                                                                {
                if (!hasPointToPointDest() || SocketFamily{ifa_broadaddr->sa_family} != SocketFamily::INET)
                        return std::nullopt;
 
                return cosmos::IP4Address{*(reinterpret_cast<sockaddr_in*>(ifa_dstaddr))};
        }

---

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

• include/net/InterfaceAddress.hxx