cosmos::SendMessageHeader::ControlMessage Class Reference

Wrapper for struct cmsghdr used for creating new control messages for sending. More...

#include <message_header.hxx>

Protected Member Functions
	ControlMessage (const OptLevel level, int type, const size_t data_len)
	Creates a new control message for the given level, type and size.
uint8_t *	data ()
	Returns the data portion of the control message.
const uint8_t *	data () const
size_t	dataSpace () const
	Returns the amount of bytes that can be stored at data().
const void *	raw () const
	Returns the pointer to the complete control message for the msg_control field in struct msghdr.
size_t	size () const
	Returns the size of the complete control message for the msg_controllen field in struct msghdr.

Protected Attributes
std::vector< uint8_t >	m_buffer
	The raw data the control message is composed of.
struct cmsghdr *	m_header = nullptr
	Pointer to the beginning of m_buffer for setting header data.

Friends
template<OptLevel , typename MSG_TYPE >
class	AncillaryMessage
class	SendMessageHeader

Detailed Description

Wrapper for struct cmsghdr used for creating new control messages for sending.

Only specialized serialization helpers may create instances of this type. These types know how to serialize their state into a ControlMessage for sending.

Definition at line 152 of file message_header.hxx.

Constructor & Destructor Documentation

ControlMessage()

cosmos::SendMessageHeader::ControlMessage::ControlMessage ( const OptLevel level, int type, const size_t data_len )

protected

Creates a new control message for the given level, type and size.

Parameters

[in]	type	The plain integer denoting the type of control message. Since this type depends on the OptLevel, there is no way to use a single strong type here. Serialization helpers need to ensure that the type and its value are sane.
[in]	data_len	The number of bytes that need to be stored in the control message. This size needs to be known in advance and cannot be changed during the lifetime of an object..

Definition at line 17 of file message_header.cxx.

                                                                                                     {
        m_buffer.resize(CMSG_SPACE(data_len));
        m_header = reinterpret_cast<cmsghdr*>(m_buffer.data());
        m_header->cmsg_level = to_integral(level);
        m_header->cmsg_type = type;
        m_header->cmsg_len = CMSG_LEN(data_len);
}

Member Function Documentation

data() [1/2]

uint8_t * cosmos::SendMessageHeader::ControlMessage::data ( )

inlineprotected

Returns the data portion of the control message.

This is the location where the actual message data needs to go.

Definition at line 178 of file message_header.hxx.

                                {
                        return CMSG_DATA(m_header);
                }

data() [2/2]

const uint8_t * cosmos::SendMessageHeader::ControlMessage::data ( ) const

inlineprotected

Definition at line 182 of file message_header.hxx.

                                            {
                        return CMSG_DATA(m_header);
                }

dataSpace()

size_t cosmos::SendMessageHeader::ControlMessage::dataSpace ( ) const

inlineprotected

Returns the amount of bytes that can be stored at data().

Definition at line 187 of file message_header.hxx.

                                         {
                        return data() - reinterpret_cast<const uint8_t*>(raw());
                }

raw()

const void * cosmos::SendMessageHeader::ControlMessage::raw ( ) const

inlineprotected

Returns the pointer to the complete control message for the msg_control field in struct msghdr.

Definition at line 192 of file message_header.hxx.

                                        {
                        return m_buffer.data();
                }

size()

size_t cosmos::SendMessageHeader::ControlMessage::size ( ) const

inlineprotected

Returns the size of the complete control message for the msg_controllen field in struct msghdr.

Definition at line 197 of file message_header.hxx.

                                    {
                        return m_buffer.size();
                }

Friends And Related Symbol Documentation

AncillaryMessage

template<OptLevel , typename MSG_TYPE >

friend class AncillaryMessage

friend

Definition at line 154 of file message_header.hxx.

SendMessageHeader

friend class SendMessageHeader

friend

Definition at line 155 of file message_header.hxx.

Member Data Documentation

m_buffer

std::vector<uint8_t> cosmos::SendMessageHeader::ControlMessage::m_buffer

protected

The raw data the control message is composed of.

Definition at line 204 of file message_header.hxx.

m_header

struct cmsghdr* cosmos::SendMessageHeader::ControlMessage::m_header = nullptr

protected

Pointer to the beginning of m_buffer for setting header data.

Definition at line 206 of file message_header.hxx.

---

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

• include/net/message_header.hxx
• src/net/message_header.cxx