cosmos::InterfaceAddressList Class Reference

Access to the list of local network interface addresses. More...

#include <InterfaceAddressList.hxx>

Public Member Functions
void	fetch ()
	Fetch a snapshot of the current list of network interface addresses.
void	clear ()
	Clear stored interface addresses.
bool	valid () const
	Returns whether currently a list of network interface addresses is available.
InterfaceAddressIterator	begin () const
InterfaceAddressIterator	end () const

Protected Attributes
struct ifaddrs *	m_addrs = nullptr

Detailed Description

Access to the list of local network interface addresses.

This class obtains the current list of local network interface addresses. Obtain a snapshot of the list via fetch() and iterate over the fetched addresses use the begin()/end() iterators.

For each network interface multiple addresses can be reported e.g. for IPv4, IPv6 and Packet (ethernet layer, MAC address).

Definition at line 19 of file InterfaceAddressList.hxx.

Constructor & Destructor Documentation

~InterfaceAddressList()

cosmos::InterfaceAddressList::~InterfaceAddressList ( )

inline

Definition at line 22 of file InterfaceAddressList.hxx.

                                {
                clear();
        }

Member Function Documentation

begin()

InterfaceAddressIterator cosmos::InterfaceAddressList::begin ( ) const

inline

Definition at line 41 of file InterfaceAddressList.hxx.

                                               {
                return InterfaceAddressIterator{m_addrs};
        }

clear()

void cosmos::InterfaceAddressList::clear

(

)

Clear stored interface addresses.

Iterating over a cleared InterfaceAddressList is allowed but yields no entries.

Definition at line 19 of file InterfaceAddressList.cxx.

                                 {
        if (m_addrs) {
                ::freeifaddrs(m_addrs);
                m_addrs = nullptr;
        }
}

end()

InterfaceAddressIterator cosmos::InterfaceAddressList::end ( ) const

inline

Definition at line 45 of file InterfaceAddressList.hxx.

                                             {
                return InterfaceAddressIterator{nullptr};
        }

fetch()

void cosmos::InterfaceAddressList::fetch

(

)

Fetch a snapshot of the current list of network interface addresses.

Definition at line 12 of file InterfaceAddressList.cxx.

                                 {
        clear();
        if (::getifaddrs(&m_addrs) != 0) {
                cosmos_throw (ApiError("getifaddrs()"));
        }
}

valid()

bool cosmos::InterfaceAddressList::valid ( ) const

inline

Returns whether currently a list of network interface addresses is available.

Definition at line 37 of file InterfaceAddressList.hxx.

                           {
                return m_addrs != nullptr;
        }

Member Data Documentation

m_addrs

struct ifaddrs* cosmos::InterfaceAddressList::m_addrs = nullptr

protected

Definition at line 51 of file InterfaceAddressList.hxx.

---

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

• include/net/InterfaceAddressList.hxx
• src/net/InterfaceAddressList.cxx