cosmos::SocketErrorMessage< FAMILY > Class Template Reference

Wrapper for the IPMessage::RECVERR ancillary message. More...

#include <ip_aux.hxx>

Inheritance diagram for cosmos::SocketErrorMessage< FAMILY >:

Public Types
using	SocketError = SocketErrorT<FAMILY>

Public Member Functions
void	deserialize (const ReceiveMessageHeader::ControlMessage &msg)
const SocketError *	error () const
	Returns the currently deserialized SocketError, if any, otherwise nullptr.

Protected Attributes
std::vector< uint8_t >	m_data

Additional Inherited Members
Protected Member Functions inherited from cosmos::AncillaryMessage< FamilyTraits< FAMILY >::OPT_LEVEL, FamilyTraits< FAMILY >::CtrlMsg >
SendMessageHeader::ControlMessage	createMsg (FamilyTraits< FAMILY >::CtrlMsg type, const size_t data_len) const
void	checkMsg (const ReceiveMessageHeader::ControlMessage &msg, FamilyTraits< FAMILY >::CtrlMsg type) const
uint8_t *	data (SendMessageHeader::ControlMessage &msg) const

Detailed Description

template<SocketFamily FAMILY>
class cosmos::SocketErrorMessage< FAMILY >

Wrapper for the IPMessage::RECVERR ancillary message.

IP based datagram sockets can report extended error messages. To receive them the MessageFlag::ERRQUEUE needs to be passed to Socket::receiveMessage().

Definition at line 28 of file ip_aux.hxx.

Member Typedef Documentation

SocketError

template<SocketFamily FAMILY>

using cosmos::SocketErrorMessage< FAMILY >::SocketError = SocketErrorT<FAMILY>

Definition at line 34 of file ip_aux.hxx.

Member Function Documentation

deserialize()

template<SocketFamily FAMILY>

void cosmos::SocketErrorMessage< FAMILY >::deserialize

(

const ReceiveMessageHeader::ControlMessage &

msg

)

Definition at line 15 of file ip_aux.cxx.

                                                                                          {
        this->checkMsg(msg, FamilyTraits<FAMILY>::CtrlMsg::RECVERR);
 
        m_data.clear();
        auto data = msg.data();
 
        // The SocketError can carry additional piggyback data not declared in
        // the struct (notably: the offender sockaddr). Thus we need to be
        // prepared to allocate more memory than sizeof(SocketError). For this
        // reason we use a vector as memory backend for the error.
 
        if (msg.dataLength() < sizeof(SocketError)) {
                cosmos_throw (RuntimeError("IP_RECVERR ancillary message too small"));
        }
 
        m_data.resize(msg.dataLength());
 
        std::memcpy(m_data.data(), data, msg.dataLength());
}

error()

template<SocketFamily FAMILY>

const SocketError * cosmos::SocketErrorMessage< FAMILY >::error ( ) const

inline

Returns the currently deserialized SocketError, if any, otherwise nullptr.

Definition at line 41 of file ip_aux.hxx.

                                         {
                if (m_data.empty())
                        return nullptr;
 
                return reinterpret_cast<const SocketError*>(m_data.data());
        }

Member Data Documentation

m_data

template<SocketFamily FAMILY>

std::vector<uint8_t> cosmos::SocketErrorMessage< FAMILY >::m_data

protected

Definition at line 49 of file ip_aux.hxx.

---

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

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