cosmos::InterfaceAddressIterator Class Reference

Iterator helper type for InterfaceAddressList. More...

#include <InterfaceAddressIterator.hxx>

Public Member Functions
auto &	operator++ ()
const InterfaceAddress &	operator* ()
bool	operator== (const InterfaceAddressIterator &other) const
bool	operator!= (const InterfaceAddressIterator &other) const

Protected Member Functions
	InterfaceAddressIterator (struct ifaddrs *pos)

Protected Attributes
struct ifaddrs *	m_pos = nullptr

Friends
class	InterfaceAddressList

Detailed Description

Iterator helper type for InterfaceAddressList.

The struct ifaddrs* stored in InterfaceAddressList is a linked list. This iterator type walks through this list. This is a simple InputIterator type.

Definition at line 14 of file InterfaceAddressIterator.hxx.

Constructor & Destructor Documentation

InterfaceAddressIterator()

cosmos::InterfaceAddressIterator::InterfaceAddressIterator ( struct ifaddrs * pos )

inlineexplicitprotected

Definition at line 18 of file InterfaceAddressIterator.hxx.

                                                               :
                        m_pos{pos} {
        }

Member Function Documentation

operator!=()

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

inline

Definition at line 45 of file InterfaceAddressIterator.hxx.

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

operator*()

const InterfaceAddress & cosmos::InterfaceAddressIterator::operator* ( )

inline

Definition at line 33 of file InterfaceAddressIterator.hxx.

                                            {
                if (!m_pos) {
                        cosmos_throw (RuntimeError("Attempt to dereference invalid InterfaceAddressIterator"));
                }
 
                return *(reinterpret_cast<InterfaceAddress*>(m_pos));
        }

operator++()

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

inline

Definition at line 24 of file InterfaceAddressIterator.hxx.

                           {
                if (m_pos) {
                        m_pos = m_pos->ifa_next;
                } else {
                        cosmos_throw (RuntimeError("Attempt to increment InterfaceAddressIterator past the end"));
                }
                return *this;
        }

operator==()

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

inline

Definition at line 41 of file InterfaceAddressIterator.hxx.

                                                                     {
                return m_pos == other.m_pos;
        }

Friends And Related Symbol Documentation

InterfaceAddressList

friend class InterfaceAddressList

friend

Definition at line 15 of file InterfaceAddressIterator.hxx.

Member Data Documentation

m_pos

struct ifaddrs* cosmos::InterfaceAddressIterator::m_pos = nullptr

protected

Definition at line 51 of file InterfaceAddressIterator.hxx.

---

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

• include/net/InterfaceAddressIterator.hxx