cosmos::InterfaceIterator Class Reference

Helper class to iterate over InterfaceEnumerator. More...

#include <InterfaceIterator.hxx>

Public Member Functions
	InterfaceIterator (const InterfaceInfo *pos)
auto &	operator++ ()
const InterfaceInfo &	operator* ()
bool	operator== (const InterfaceIterator &other) const
bool	operator!= (const InterfaceIterator &other) const

Protected Attributes
const InterfaceInfo *	m_pos = &M_END

Static Protected Attributes
static constexpr InterfaceInfo	M_END = InterfaceInfo{}

Detailed Description

Helper class to iterate over InterfaceEnumerator.

InterfaceEnumerator holds a list of structures allocated in libc. This iterator is able to iterate over the list. Usually you don't need to use it explicitly, a range based for loop used on InterfaceEnumerator will use it automatically.

The end of the array is marked by a nullptr if_name and zero if_index. We keep such an element in the M_END member, which serves as the end() iterator in InterfaceEnumerator.

Definition at line 20 of file InterfaceIterator.hxx.

Constructor & Destructor Documentation

InterfaceIterator() [1/2]

cosmos::InterfaceIterator::InterfaceIterator ( )

inlineconstexpr

Definition at line 23 of file InterfaceIterator.hxx.

{}

InterfaceIterator() [2/2]

cosmos::InterfaceIterator::InterfaceIterator ( const InterfaceInfo * pos )

inline

Definition at line 25 of file InterfaceIterator.hxx.

                                                    :
                m_pos{pos ? pos : &M_END}
        {}

Member Function Documentation

operator!=()

bool cosmos::InterfaceIterator::operator!= ( const InterfaceIterator & other ) const

inline

Definition at line 57 of file InterfaceIterator.hxx.

                                                              {
                return !(*this == other);
        }

operator*()

const InterfaceInfo & cosmos::InterfaceIterator::operator* ( )

inline

Definition at line 39 of file InterfaceIterator.hxx.

                                         {
                if (!m_pos || m_pos->if_name == nullptr) {
                        cosmos_throw (RuntimeError("Attempt to dereference invalid InterfaceIterator"));
                }
 
                return *m_pos;
        }

operator++()

auto & cosmos::InterfaceIterator::operator++ ( )

inline

Definition at line 29 of file InterfaceIterator.hxx.

                           {
                if (m_pos && m_pos->if_name != nullptr) {
                        m_pos++;
                } else {
                        cosmos_throw (RuntimeError("Attempt to increment InterfaceIterator past the end"));
                }
 
                return *this;
        }

operator==()

bool cosmos::InterfaceIterator::operator== ( const InterfaceIterator & other ) const

inline

Definition at line 47 of file InterfaceIterator.hxx.

                                                              {
                if (m_pos == other.m_pos)
                        return true;
                else if (!m_pos || !other.m_pos)
                        return false;
 
                return m_pos->if_name == other.m_pos->if_name &&
                        m_pos->if_index == other.m_pos->if_index;
        }

Member Data Documentation

M_END

InterfaceInfo cosmos::InterfaceIterator::M_END = InterfaceInfo{}

staticconstexprprotected

Definition at line 63 of file InterfaceIterator.hxx.

{};

m_pos

const InterfaceInfo* cosmos::InterfaceIterator::m_pos = &M_END

protected

Definition at line 65 of file InterfaceIterator.hxx.

---

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

• include/net/InterfaceIterator.hxx