Wrapper for socket extended errors ancillary message of types IP4Message::RECVERR and IP6Message::RECVERR. More...

#include <SocketError.hxx>

Inheritance diagram for cosmos::SocketErrorT< FAMILY >:

Public Types
enum class	Origin : uint8_t { NONE = SO_EE_ORIGIN_NONE , LOCAL = SO_EE_ORIGIN_LOCAL , ICMP = SO_EE_ORIGIN_ICMP , ICMP6 = SO_EE_ORIGIN_ICMP6 , TXSTATUS = SO_EE_ORIGIN_TXSTATUS , ZEROCOPY = SO_EE_ORIGIN_ZEROCOPY , TXTIME = SO_EE_ORIGIN_TXTIME }
	This defines where the extended error originated. More...

enum class	ZeroCopyCode : uint8_t { ZEROCOPY_COPIED = SO_EE_CODE_ZEROCOPY_COPIED }
	Code definitions for Origin::ZEROCOPY. More...

enum class	TxTimeCode : uint8_t { TXTIME_INVALID_PARAM = SO_EE_CODE_TXTIME_INVALID_PARAM , TXTIME_MISSED = SO_EE_CODE_TXTIME_MISSED }
	Code definitions for Origin::TXTIME. More...

using	IPAddress = typename FamilyTraits<FAMILY>::Address

Public Member Functions
Origin	origin () const
	The origin defines how the rest of the error data is interpreted.

Errno	errnum () const
	The error code is always available, but may be Errno::NO_ERROR.

std::optional< uint32_t >	discoveredMTU () const
	If errnum() is Errno::MSG_TOO_LARGE then this returns the currently known MTU.

std::optional< ZeroCopyCode >	zeroCopyCode () const

std::optional< TxTimeCode >	txTimeCode () const

std::optional< std::pair< uint32_t, uint32_t > >	zeroCopyRange () const
	Return the copied ranges for zerocopy status reports.

bool	originIsICMP () const

std::optional< uint8_t >	icmpType () const

std::optional< uint8_t >	icmpCode () const

SocketFamily	offenderAddressFamily () const

bool	hasOffenderAddress () const
	Check whether the offender IP address is available.

std::optional< IPAddress >	offenderAddress () const

Protected Member Functions
const struct sockaddr *	offenderAddr () const

Detailed Description

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

Wrapper for socket extended errors ancillary message of types IP4Message::RECVERR and IP6Message::RECVERR.

This data structure is passed for IP based sockets if the IP4Options::setReceiveErrors() or IP6Options::setReceiveErrors() option is enabled. Extended error reporting generally only works for SocketType::DGRAM sockets. All errors on the socket will be queued in a separate error message queue and these errors can be received using Socket::receiveMessage() with the MessageFlag::ERRQUEUE set.

Various kinds of data can be part of this structure. The exact interpretation depends upon the Origin and error() code. For this reason various functions only return optional values.

Definition at line 35 of file SocketError.hxx.

Member Typedef Documentation

◆ IPAddress

template<SocketFamily FAMILY>

using cosmos::SocketErrorT< FAMILY >::IPAddress = typename FamilyTraits<FAMILY>::Address

Definition at line 39 of file SocketError.hxx.

Member Enumeration Documentation

◆ Origin

template<SocketFamily FAMILY>

enum class cosmos::SocketErrorT::Origin : uint8_t

strong

This defines where the extended error originated.

Enumerator
LOCAL	The local networking stack detected an error.
ICMP	An ICMPv4 error was reported.
ICMP6	An ICMPv6 error was reported.
ZEROCOPY	Status report for zerocopy operation (see Linux kernel documentation networking/msg_zerocopy.txt).

Definition at line 42 of file SocketError.hxx.

                          : uint8_t {
                NONE     = SO_EE_ORIGIN_NONE,
                LOCAL    = SO_EE_ORIGIN_LOCAL,
                ICMP     = SO_EE_ORIGIN_ICMP,
                ICMP6    = SO_EE_ORIGIN_ICMP6,
                TXSTATUS = SO_EE_ORIGIN_TXSTATUS,
                ZEROCOPY = SO_EE_ORIGIN_ZEROCOPY,
                TXTIME   = SO_EE_ORIGIN_TXTIME
        };

◆ TxTimeCode

template<SocketFamily FAMILY>

enum class cosmos::SocketErrorT::TxTimeCode : uint8_t

strong

Code definitions for Origin::TXTIME.

Definition at line 63 of file SocketError.hxx.

                              : uint8_t {
                TXTIME_INVALID_PARAM = SO_EE_CODE_TXTIME_INVALID_PARAM,
                TXTIME_MISSED        = SO_EE_CODE_TXTIME_MISSED
        };

◆ ZeroCopyCode

template<SocketFamily FAMILY>

enum class cosmos::SocketErrorT::ZeroCopyCode : uint8_t

strong

Code definitions for Origin::ZEROCOPY.

Enumerator
ZEROCOPY_COPIED	No zerocopy was performed, the kernel performed a copy.

Definition at line 57 of file SocketError.hxx.

                                : uint8_t {
                ZEROCOPY_COPIED      = SO_EE_CODE_ZEROCOPY_COPIED,
        };

Member Function Documentation

◆ discoveredMTU()

template<SocketFamily FAMILY>

std::optional< uint32_t > cosmos::SocketErrorT< FAMILY >::discoveredMTU ( ) const

inline

If errnum() is Errno::MSG_TOO_LARGE then this returns the currently known MTU.

Definition at line 82 of file SocketError.hxx.

                                                    {
                if (errnum() == Errno::MSG_TOO_LARGE) {
                        return this->ee_info;
                }
 
                return std::nullopt;
        }

◆ errnum()

template<SocketFamily FAMILY>

Errno cosmos::SocketErrorT< FAMILY >::errnum ( ) const

inline

The error code is always available, but may be Errno::NO_ERROR.

Definition at line 76 of file SocketError.hxx.

                             {
                // ee_errno is unsigned, while errno is signed
                return Errno{static_cast<std::underlying_type<Errno>::type>(this->ee_errno)};
        }

◆ hasOffenderAddress()

template<SocketFamily FAMILY>

bool cosmos::SocketErrorT< FAMILY >::hasOffenderAddress ( ) const

inline

Check whether the offender IP address is available.

If available then the kernel also provides the IP address of the node that caused the error. offenderAddress() allows to access the address, if applicable.

Definition at line 149 of file SocketError.hxx.

                                        {
                return offenderAddressFamily() != SocketFamily::UNSPEC;
        }

◆ icmpCode()

template<SocketFamily FAMILY>

std::optional< uint8_t > cosmos::SocketErrorT< FAMILY >::icmpCode ( ) const

inline

Definition at line 131 of file SocketError.hxx.

                                              {
                if (originIsICMP()) {
                        return this->ee_code;
                }
 
                return std::nullopt;
        }

◆ icmpType()

template<SocketFamily FAMILY>

std::optional< uint8_t > cosmos::SocketErrorT< FAMILY >::icmpType ( ) const

inline

Definition at line 123 of file SocketError.hxx.

                                              {
                if (originIsICMP()) {
                        return this->ee_type;
                }
 
                return std::nullopt;
        }

◆ offenderAddr()

template<SocketFamily FAMILY>

const struct sockaddr * cosmos::SocketErrorT< FAMILY >::offenderAddr ( ) const

inlineprotected

Definition at line 163 of file SocketError.hxx.

                                                    {
                // this is piggyback data found after the end of the struct
                // sock_extended_err. It is only valid if sa_family !=
                // AF_UNSPEC.
                return SO_EE_OFFENDER(this);
        }

◆ offenderAddress()

template<SocketFamily FAMILY>

std::optional< IPAddress > cosmos::SocketErrorT< FAMILY >::offenderAddress ( ) const

inline

Definition at line 153 of file SocketError.hxx.

                                                       {
                if (offenderAddressFamily() != FAMILY)
                        return std::nullopt;
 
                using RawAddr = typename FamilyTraits<FAMILY>::RawAddr;
                return IPAddress{*reinterpret_cast<const RawAddr*>(offenderAddr())};
        }

◆ offenderAddressFamily()

template<SocketFamily FAMILY>

SocketFamily cosmos::SocketErrorT< FAMILY >::offenderAddressFamily ( ) const

inline

Definition at line 139 of file SocketError.hxx.

                                                   {
                return SocketFamily(offenderAddr()->sa_family);
        }

◆ origin()

template<SocketFamily FAMILY>

Origin cosmos::SocketErrorT< FAMILY >::origin ( ) const

inline

The origin defines how the rest of the error data is interpreted.

Definition at line 71 of file SocketError.hxx.

                              {
                return Origin{this->ee_origin};
        }

◆ originIsICMP()

template<SocketFamily FAMILY>

bool cosmos::SocketErrorT< FAMILY >::originIsICMP ( ) const

inline

Definition at line 119 of file SocketError.hxx.

                                  {
                return origin() == Origin::ICMP || origin() == Origin::ICMP6;
        }

◆ txTimeCode()

template<SocketFamily FAMILY>

std::optional< TxTimeCode > cosmos::SocketErrorT< FAMILY >::txTimeCode ( ) const

inline

Definition at line 98 of file SocketError.hxx.

                                                   {
                if (origin() == Origin::TXTIME) {
                        return TxTimeCode{this->ee_code};
                }
 
                return std::nullopt;
        }

◆ zeroCopyCode()

template<SocketFamily FAMILY>

std::optional< ZeroCopyCode > cosmos::SocketErrorT< FAMILY >::zeroCopyCode ( ) const

inline

Definition at line 90 of file SocketError.hxx.

                                                       {
                if (origin() == Origin::ZEROCOPY) {
                        return ZeroCopyCode{this->ee_code};
                }
 
                return std::nullopt;
        }

◆ zeroCopyRange()

template<SocketFamily FAMILY>

std::optional< std::pair< uint32_t, uint32_t > > cosmos::SocketErrorT< FAMILY >::zeroCopyRange ( ) const

inline

Return the copied ranges for zerocopy status reports.

If this is a zerocopy status report from the kernel then this returns the range of transmissions that have been completed.

Definition at line 111 of file SocketError.hxx.

                                                                       {
                if (origin() == Origin::ZEROCOPY) {
                        return std::make_pair(this->ee_info, this->ee_data);
                }
 
                return std::nullopt;
        }

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

include/net/SocketError.hxx

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ IPAddress

Member Enumeration Documentation

◆ Origin

◆ TxTimeCode

◆ ZeroCopyCode

Member Function Documentation

◆ discoveredMTU()

◆ errnum()

◆ hasOffenderAddress()

◆ icmpCode()

◆ icmpType()

◆ offenderAddr()

◆ offenderAddress()

◆ offenderAddressFamily()

◆ origin()

◆ originIsICMP()

◆ txTimeCode()

◆ zeroCopyCode()

◆ zeroCopyRange()