cosmos::InterfaceEnumerator Class Reference

Enumerate all local network interfaces. More...

#include <InterfaceEnumerator.hxx>

Public Member Functions
void	fetch ()
	Fetch a new snapshot of InterfaceInfo instances.
void	clear ()
	Clear a previously fetched result.
InterfaceIterator	begin ()
InterfaceIterator	end ()
bool	valid () const

Protected Attributes
InterfaceInfo *	m_list = nullptr

Detailed Description

Enumerate all local network interfaces.

This type allows to retrieve a list of all local network interfaces. The network interface names and interface indexes are available.

To get a new snapshot of the network interface list call fetch(). The begin() and end() iterators allow to iterate over all found entries.

Iterating over an empty enumerator instance is allowed and will yield an empty list.

Definition at line 22 of file InterfaceEnumerator.hxx.

Constructor & Destructor Documentation

~InterfaceEnumerator()

cosmos::InterfaceEnumerator::~InterfaceEnumerator ( )

inline

Definition at line 24 of file InterfaceEnumerator.hxx.

                               {
                clear();
        }

Member Function Documentation

begin()

InterfaceIterator cosmos::InterfaceEnumerator::begin ( )

inline

Definition at line 34 of file InterfaceEnumerator.hxx.

                                  {
                return InterfaceIterator{m_list};
        }

clear()

void cosmos::InterfaceEnumerator::clear

(

)

Clear a previously fetched result.

Definition at line 11 of file InterfaceEnumerator.cxx.

                                {
        if (m_list) {
                ::if_freenameindex(m_list);
                m_list = nullptr;
        }
}

end()

InterfaceIterator cosmos::InterfaceEnumerator::end ( )

inline

Definition at line 38 of file InterfaceEnumerator.hxx.

                                {
                return InterfaceIterator{};
        }

fetch()

void cosmos::InterfaceEnumerator::fetch

(

)

Fetch a new snapshot of InterfaceInfo instances.

Definition at line 18 of file InterfaceEnumerator.cxx.

                                {
        clear();
        m_list = reinterpret_cast<InterfaceInfo*>(::if_nameindex());
 
        if (!m_list) {
                cosmos_throw(ApiError("ifnameindex()"));
        }
}

valid()

bool cosmos::InterfaceEnumerator::valid ( ) const

inline

Definition at line 42 of file InterfaceEnumerator.hxx.

                           {
                return m_list != nullptr;
        }

Member Data Documentation

m_list

InterfaceInfo* cosmos::InterfaceEnumerator::m_list = nullptr

protected

Definition at line 47 of file InterfaceEnumerator.hxx.

---

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

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