cosmos::WouldBlock Class Reference

Specialized ApiError for handling non-blocking operation. More...

#include <WouldBlock.hxx>

Inheritance diagram for cosmos::WouldBlock:

Public Member Functions
	WouldBlock (const std::string_view prefix={})
Public Member Functions inherited from cosmos::ApiError
	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.

Public Attributes
	COSMOS_ERROR_IMPL
Public Attributes inherited from cosmos::ApiError
	COSMOS_ERROR_IMPL

Additional Inherited Members
Static Public Member Functions inherited from cosmos::ApiError
static std::string	msg (const Errno err)
	Returns a human readable error message for the given errno code.
Protected Member Functions inherited from cosmos::ApiError
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 inherited from cosmos::ApiError
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 ApiError for handling non-blocking operation.

When using APIs in non-blocking mode then Errno::AGAIN or Errno::WOULD_BLOCK frequently occur when no data is available. To handle these situations more expressively this specialized exception type is provided that allows to catch this context explicitly without having to check for special Errno values in ApiError.

Definition at line 16 of file WouldBlock.hxx.

Constructor & Destructor Documentation

WouldBlock()

cosmos::WouldBlock::WouldBlock ( const std::string_view prefix = {} )

inline

Definition at line 19 of file WouldBlock.hxx.

                                                 {}) :
                ApiError{prefix}
        {}

Member Data Documentation

COSMOS_ERROR_IMPL

cosmos::WouldBlock::COSMOS_ERROR_IMPL

Definition at line 23 of file WouldBlock.hxx.

---

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

• include/error/WouldBlock.hxx