cosmos::AddressInfoIterator Struct Reference

Helper class to iterate over AddressInfoList. More...

#include <AddressInfoIterator.hxx>

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

Protected Attributes
const AddressInfo *	m_pos = nullptr

Detailed Description

Helper class to iterate over AddressInfoList.

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

The end of the list is marked by a nullptr ai_next field in AddressInfo.

Definition at line 18 of file AddressInfoIterator.hxx.

Constructor & Destructor Documentation

AddressInfoIterator() [1/2]

cosmos::AddressInfoIterator::AddressInfoIterator ( )

inline

Definition at line 21 of file AddressInfoIterator.hxx.

{}

AddressInfoIterator() [2/2]

cosmos::AddressInfoIterator::AddressInfoIterator ( const AddressInfo * pos )

inlineexplicit

Definition at line 23 of file AddressInfoIterator.hxx.

                                                             :
                m_pos{pos}
        {}

Member Function Documentation

operator!=()

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

inline

Definition at line 49 of file AddressInfoIterator.hxx.

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

operator*()

const AddressInfo & cosmos::AddressInfoIterator::operator* ( )

inline

Definition at line 37 of file AddressInfoIterator.hxx.

                                       {
                if (!m_pos) {
                        cosmos_throw (RuntimeError("Attempt to dereference an invalid AddressInfoIterator"));
                }
 
                return *m_pos;
        }

operator++()

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

inline

Definition at line 27 of file AddressInfoIterator.hxx.

                           {
                if (!m_pos) {
                        cosmos_throw (RuntimeError("Attempt to increment past the end() AddressInfoIterator"));
                }
 
                m_pos = m_pos->next();
 
                return *this;
        }

operator==()

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

inline

Definition at line 45 of file AddressInfoIterator.hxx.

                                                                {
                return m_pos == other.m_pos;
        }

Member Data Documentation

m_pos

const AddressInfo* cosmos::AddressInfoIterator::m_pos = nullptr

protected

Definition at line 55 of file AddressInfoIterator.hxx.

---

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

• include/net/AddressInfoIterator.hxx