cosmos::ReceiveMessageHeader::ControlMessage Class Reference

Wrapper for struct cmsghdr used for iterating over received control messages. More...

#include <message_header.hxx>

Public Member Functions
OptLevel	level () const
	This defines the basic option level this control message is for.
std::optional< UnixMessage >	asUnixMessage () const
	Return the UnixMessage ancillary message type, if applicable.
std::optional< IP4Message >	asIP4Message () const
std::optional< IP6Message >	asIP6Message () const
const void *	data () const
	Returns the data portion of the control message.
size_t	dataLength () const
	The amount of bytes found at data().

Protected Member Functions
int	type () const
	Returns the raw control message type (which is a different type depending on level().
auto	length () const
	Returns the length of this control message including the header.

Protected Attributes
struct cmsghdr	m_header
	The raw control message header of this ancillary message.

Friends
template<OptLevel , typename MSG_TYPE >
class	AncillaryMessage

Detailed Description

Wrapper for struct cmsghdr used for iterating over received control messages.

Definition at line 256 of file message_header.hxx.

Member Function Documentation

asIP4Message()

std::optional< IP4Message > cosmos::ReceiveMessageHeader::ControlMessage::asIP4Message ( ) const

inline

Definition at line 291 of file message_header.hxx.

                                                             {
                        if (level() == OptLevel::IP) {
                                return IP4Message{type()};
                        }
 
                        return std::nullopt;
                }

asIP6Message()

std::optional< IP6Message > cosmos::ReceiveMessageHeader::ControlMessage::asIP6Message ( ) const

inline

Definition at line 299 of file message_header.hxx.

                                                             {
                        if (level() == OptLevel::IPV6) {
                                return IP6Message{type()};
                        }
 
                        return std::nullopt;
                }

asUnixMessage()

std::optional< UnixMessage > cosmos::ReceiveMessageHeader::ControlMessage::asUnixMessage ( ) const

inline

Return the UnixMessage ancillary message type, if applicable.

Definition at line 283 of file message_header.hxx.

                                                               {
                        if (level() == OptLevel::SOCKET) {
                                return UnixMessage{type()};
                        }
 
                        return std::nullopt;
                }

data()

const void * cosmos::ReceiveMessageHeader::ControlMessage::data ( ) const

inline

Returns the data portion of the control message.

This pointer is not necessarily suitably aligned to access arbitrary (casted) data structures through it. Applications need to copy the data via memcpy() into suitably located data structures.

Definition at line 314 of file message_header.hxx.

                                         {
                        return CMSG_DATA(&m_header);
                }

dataLength()

size_t cosmos::ReceiveMessageHeader::ControlMessage::dataLength ( ) const

inline

The amount of bytes found at data().

Definition at line 319 of file message_header.hxx.

                                          {
                        return length() - sizeof(m_header);
                }

length()

auto cosmos::ReceiveMessageHeader::ControlMessage::length ( ) const

inlineprotected

Returns the length of this control message including the header.

Definition at line 267 of file message_header.hxx.

                                    {
                        return m_header.cmsg_len;
                }

level()

OptLevel cosmos::ReceiveMessageHeader::ControlMessage::level ( ) const

inline

This defines the basic option level this control message is for.

The option level determines how the rest of the control message is to be interpreted.

Definition at line 278 of file message_header.hxx.

                                       {
                        return OptLevel{m_header.cmsg_level};
                }

type()

int cosmos::ReceiveMessageHeader::ControlMessage::type ( ) const

inlineprotected

Returns the raw control message type (which is a different type depending on level().

Definition at line 262 of file message_header.hxx.

                                 {
                        return m_header.cmsg_type;
                }

Friends And Related Symbol Documentation

AncillaryMessage

template<OptLevel , typename MSG_TYPE >

friend class AncillaryMessage

friend

Definition at line 258 of file message_header.hxx.

Member Data Documentation

m_header

struct cmsghdr cosmos::ReceiveMessageHeader::ControlMessage::m_header

protected

The raw control message header of this ancillary message.

Definition at line 326 of file message_header.hxx.

---

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

• include/net/message_header.hxx