cosmos::ReceiveMessageHeader::ControlMessageIterator Class Reference

Helper type for iterating over ControlMessage instances received in a ReceiveMessageHeader. More...

#include <message_header.hxx>

Public Member Functions
	ControlMessageIterator ()
	Create an invalid (end) iterator.
	ControlMessageIterator (const ReceiveMessageHeader &header)
	Create an iterator pointing to the first ControlMessage of header.
auto &	operator++ ()
	Advance to the next ControlMessage, or to the end of the range.
bool	operator== (const ControlMessageIterator &other) const
bool	operator!= (const ControlMessageIterator &other) const
const ControlMessage &	operator* ()
	Access the current ControlMessage the iterator points to.

Protected Attributes
const cmsghdr *	m_pos = nullptr
const ReceiveMessageHeader *	m_header = nullptr

Detailed Description

Helper type for iterating over ControlMessage instances received in a ReceiveMessageHeader.

Definition at line 330 of file message_header.hxx.

Constructor & Destructor Documentation

ControlMessageIterator() [1/2]

cosmos::ReceiveMessageHeader::ControlMessageIterator::ControlMessageIterator ( )

inline

Create an invalid (end) iterator.

Definition at line 334 of file message_header.hxx.

{}

ControlMessageIterator() [2/2]

cosmos::ReceiveMessageHeader::ControlMessageIterator::ControlMessageIterator ( const ReceiveMessageHeader & header )

inlineexplicit

Create an iterator pointing to the first ControlMessage of header.

If there is no ControlMessage in header then an invalid (end) iterator is the result.

Definition at line 341 of file message_header.hxx.

                                                                                    :
                                m_pos{CMSG_FIRSTHDR(&header.m_header)},
                                m_header{&header} {
                }

Member Function Documentation

operator!=()

bool cosmos::ReceiveMessageHeader::ControlMessageIterator::operator!= ( const ControlMessageIterator & other ) const

inline

Definition at line 363 of file message_header.hxx.

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

operator*()

const ControlMessage & cosmos::ReceiveMessageHeader::ControlMessageIterator::operator* ( )

inline

Access the current ControlMessage the iterator points to.

Definition at line 368 of file message_header.hxx.

                                                  {
                        if (!m_pos) {
                                cosmos_throw (RuntimeError("Attempt to dereference an invalid ControlMessageIterator"));
                        }
 
                        return *reinterpret_cast<const ControlMessage*>(m_pos);
                }

operator++()

auto & cosmos::ReceiveMessageHeader::ControlMessageIterator::operator++ ( )

inline

Advance to the next ControlMessage, or to the end of the range.

Definition at line 347 of file message_header.hxx.

                                   {
                        if (m_pos) {
                                const msghdr *hdr = m_header->rawHeader();
                                const cmsghdr *chdr = m_pos;
                                m_pos = CMSG_NXTHDR(const_cast<msghdr*>(hdr), const_cast<cmsghdr*>(chdr));
                        } else {
                                cosmos_throw (RuntimeError("Attempt to increment ControlMessageIterator past the end"));
                        }
 
                        return *this;
                }

operator==()

bool cosmos::ReceiveMessageHeader::ControlMessageIterator::operator== ( const ControlMessageIterator & other ) const

inline

Definition at line 359 of file message_header.hxx.

                                                                           {
                        return m_pos == other.m_pos;
                }

Member Data Documentation

m_header

const ReceiveMessageHeader* cosmos::ReceiveMessageHeader::ControlMessageIterator::m_header = nullptr

protected

Definition at line 379 of file message_header.hxx.

m_pos

const cmsghdr* cosmos::ReceiveMessageHeader::ControlMessageIterator::m_pos = nullptr

protected

Definition at line 378 of file message_header.hxx.

---

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

• include/net/message_header.hxx