cosmos::ApiError Class Reference

Specialized exception type used when system APIs fail. More...

#include <ApiError.hxx>

Inheritance diagram for cosmos::ApiError:

Public Member Functions
	ApiError (const std::string_view prefix)
	Stores the current errno code in the exception.
	ApiError (const std::string_view prefix, const Errno err)
	Stores the given errno code in the exception.
std::string	msg () const
	Returns the plain operating system error message.
auto	errnum () const
	Returns the plain errno stored in the exception.
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	msg (const Errno err)
	Returns a human readable error message for the given errno 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
Errno	m_errno = Errno::NO_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 exception type used when system APIs fail.

This exception type will store a well known errno code as a member and format a human readable error message from it.

Definition at line 17 of file ApiError.hxx.

Constructor & Destructor Documentation

ApiError() [1/2]

cosmos::ApiError::ApiError ( const std::string_view prefix )

explicit

Stores the current errno code in the exception.

Definition at line 11 of file ApiError.cxx.

                                              :
                ApiError{prefix, Errno{errno}} {
}

ApiError() [2/2]

cosmos::ApiError::ApiError	(	const std::string_view	prefix,
		const Errno	err )

Stores the given errno code in the exception.

Definition at line 15 of file ApiError.cxx.

                                                               :
                CosmosError{"ApiError"},
                m_errno{err} {
        if (!prefix.empty()) {
                m_msg = prefix;
                m_msg += ": ";
        }
}

Member Function Documentation

errnum()

auto cosmos::ApiError::errnum ( ) const

inline

Returns the plain errno stored in the exception.

Definition at line 34 of file ApiError.hxx.

{ return m_errno; }

generateMsg()

void cosmos::ApiError::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.

Reimplemented in cosmos::FileError.

Definition at line 24 of file ApiError.cxx.

                                 {
        std::stringstream ss;
        ss << m_errno;
 
        m_msg += ss.str();
}

msg() [1/2]

std::string cosmos::ApiError::msg ( ) const

inline

Returns the plain operating system error message.

Definition at line 28 of file ApiError.hxx.

{ return msg(m_errno); }

msg() [2/2]

std::string cosmos::ApiError::msg ( const Errno err )

static

Returns a human readable error message for the given errno code.

Definition at line 31 of file ApiError.cxx.

                                       {
        char error[512];
 
        const char *text = ::strerror_r(to_integral(err), &error[0], sizeof(error));
 
        return text;
}

Member Data Documentation

COSMOS_ERROR_IMPL

cosmos::ApiError::COSMOS_ERROR_IMPL

Definition at line 36 of file ApiError.hxx.

m_errno

Errno cosmos::ApiError::m_errno = Errno::NO_ERROR

protected

Definition at line 44 of file ApiError.hxx.

---

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

• include/error/ApiError.hxx
• src/error/ApiError.cxx