Specialized error type for AddressInfoList resolve errors. More...

#include <ResolveError.hxx>

Inheritance diagram for cosmos::ResolveError:

Public Types
enum class	Code : int { ADDR_FAMILY = EAI_ADDRFAMILY , AGAIN = EAI_AGAIN , BAD_FLAGS = EAI_BADFLAGS , FAIL = EAI_FAIL , FAMILY = EAI_FAMILY , MEMORY = EAI_MEMORY , NO_DATA = EAI_NODATA , NO_NAME = EAI_NONAME , SERVICE = EAI_SERVICE , SOCKTYPE = EAI_SOCKTYPE , SYSTEM = EAI_SYSTEM , OVERFLOW = EAI_OVERFLOW }
	Possible resolve error codes that can be stored in ResolveError. More...

Public Member Functions
	ResolveError (const Code code)
	Create a ResolveError for the given error code.

Code	code () const
	Returns the plain resolve error code stored in the exception.

Errno	systemError () const
	Returns the "other system error" if code() is Code::SYSTEM.

std::string_view	msg () const
	Returns the plain resolver error message.

Public Member Functions inherited from cosmos::CosmosError
	CosmosError (const std::string_view error_class, const std::string_view fixed_text={})

CosmosError &	setInfo (const char file, const size_t line, const char func)
	Set exception context information.

const char *	what () const override throw ()
	Implementation of the std::exception interface.

std::string	shortWhat () const
	Returns a shorter description of the error without verbose context.

virtual void	raise ()=0
	Throw the most specialized type of this object in the inheritance hierarchy.

Static Public Member Functions
static std::string_view	msg (const Code code)

Public Attributes
	COSMOS_ERROR_IMPL

Protected Member Functions
void	generateMsg () const override
	Append type specific error information to m_msg.

Protected Member Functions inherited from cosmos::CosmosError
void	setErrorClass (const std::string_view error_class)
	Allows to override error class to allow simpler implementation of derived types.

Protected Attributes
Code	m_eai_code
	The plain resolve error code.

Errno	m_system_errno
	If m_eai_code == Code::EAI_SYSTEM this contains the system error.

Protected Attributes inherited from cosmos::CosmosError
std::string_view	m_error_class
	Descriptive, unique error class label.

std::string	m_msg
	Runtime generated error message.

bool	m_msg_generated = false
	Whether m_msg has been assembled yet.

const char *	m_file = nullptr

const char *	m_func = nullptr

size_t	m_line = 0

Detailed Description

Specialized error type for AddressInfoList resolve errors.

DNS name resolution in Linux APIs uses a separate error reporting mechanism. This error type covers this mechanism.

Definition at line 26 of file ResolveError.hxx.

Member Enumeration Documentation

◆ Code

enum class cosmos::ResolveError::Code : int

strong

Possible resolve error codes that can be stored in ResolveError.

Enumerator
ADDR_FAMILY	The specified network host does not have any network addresses in the requested family.
AGAIN	The name server returned a temporary failure indication.
BAD_FLAGS	Bad AddressHints::Flags encountered.
FAIL	A permanent failure has been indicated by the nameserver.
FAMILY	The requested address family is not supported.
MEMORY	Out of memory.
NO_DATA	The requested network host exists but has no network address defined.
NO_NAME	The node or service is not known; or Flags::NUMERIC_SERVICE was specified and service was not a number.
SERVICE	The requested service is not available for the requested SocketType.
SOCKTYPE	The requested SocketType is not supported.
SYSTEM	Other system error, check Errno from systemError().
OVERFLOW	The buffer pointed to by host or serv was too small (only used in IPAddress::getNameInfo()).

Definition at line 31 of file ResolveError.hxx.

                        : int {
                ADDR_FAMILY = EAI_ADDRFAMILY,
                AGAIN       = EAI_AGAIN,
                BAD_FLAGS   = EAI_BADFLAGS,
                FAIL        = EAI_FAIL,
                FAMILY      = EAI_FAMILY,
                MEMORY      = EAI_MEMORY,
                NO_DATA     = EAI_NODATA,
                NO_NAME     = EAI_NONAME,
                SERVICE     = EAI_SERVICE,
                SOCKTYPE    = EAI_SOCKTYPE,
                SYSTEM      = EAI_SYSTEM,
                OVERFLOW    = EAI_OVERFLOW,
        };

Constructor & Destructor Documentation

◆ ResolveError()

cosmos::ResolveError::ResolveError ( const Code code )

explicit

Create a ResolveError for the given error code.

If code is Code::SYSTEM then the current Errno will also be stored in the exception.

Definition at line 35 of file ResolveError.cxx.

                                          :
                CosmosError{"ResolveError"},
                m_eai_code{code},
                m_system_errno{code == Code::SYSTEM ? get_errno() : Errno::NO_ERROR} {
}

Member Function Documentation

◆ code()

Code cosmos::ResolveError::code ( ) const

inline

Returns the plain resolve error code stored in the exception.

Definition at line 68 of file ResolveError.hxx.

                          {
                return m_eai_code;
        }

◆ generateMsg()

void cosmos::ResolveError::generateMsg ( ) const

overrideprotectedvirtual

Append type specific error information to m_msg.

This function is called by the implementation when error specific information needs to be appended to the m_msg string.

At entry into this function m_msg can already contain data that must not be discarded.

This function will be called at most once during the lifetime of an object, and only if the error message actually needs to be generated due to a call to what().

Reimplemented from cosmos::CosmosError.

Definition at line 47 of file ResolveError.cxx.

                                     {
        std::stringstream ss;
        ss << m_eai_code;
 
        if (m_eai_code == Code::SYSTEM) {
                ss << " (errno = " << m_system_errno << ")";
        }
 
        m_msg += ss.str();
}

◆ msg() [1/2]

std::string_view cosmos::ResolveError::msg ( ) const

inline

Returns the plain resolver error message.

Definition at line 81 of file ResolveError.hxx.

81{ return msg(m_eai_code); }

cosmos::ResolveError::msg

std::string_view msg() const

Returns the plain resolver error message.

Definition ResolveError.hxx:81

◆ msg() [2/2]

std::string_view cosmos::ResolveError::msg ( const Code code )

static

This returns a statically allocated string so we can use string_view here.

Definition at line 41 of file ResolveError.cxx.

                                                {
        return gai_strerror(to_integral(code));
}

◆ systemError()

Errno cosmos::ResolveError::systemError ( ) const

inline

Returns the "other system error" if code() is Code::SYSTEM.

If there is no system error then Errno::NO_ERROR is returned.

Definition at line 76 of file ResolveError.hxx.

                                  {
                return m_system_errno;
        }

Member Data Documentation

◆ COSMOS_ERROR_IMPL

cosmos::ResolveError::COSMOS_ERROR_IMPL

Definition at line 85 of file ResolveError.hxx.

◆ m_eai_code

Code cosmos::ResolveError::m_eai_code

protected

The plain resolve error code.

Definition at line 94 of file ResolveError.hxx.

◆ m_system_errno

Errno cosmos::ResolveError::m_system_errno

protected

If m_eai_code == Code::EAI_SYSTEM this contains the system error.

Definition at line 96 of file ResolveError.hxx.

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

include/error/ResolveError.hxx
src/error/ResolveError.cxx

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Code

Constructor & Destructor Documentation

◆ ResolveError()

Member Function Documentation

◆ code()

◆ generateMsg()

◆ msg() [1/2]

◆ msg() [2/2]

◆ systemError()

Member Data Documentation

◆ COSMOS_ERROR_IMPL

◆ m_eai_code

◆ m_system_errno