asio::error_code Class Reference

Class to represent an error code value. More...

#include <error_code.hpp>

Classes
struct	unspecified_bool_type_t

Public Types
typedef void(*	unspecified_bool_type) (unspecified_bool_type_t)

Public Member Functions
	error_code ()
	Default constructor. More...
	error_code (int v, const error_category &c)
	Construct with specific error code and category. More...
template<typename ErrorEnum >
	error_code (ErrorEnum e)
	Construct from an error code enum. More...
int	value () const
	Get the error value. More...
const error_category &	category () const
	Get the error category. More...
std::string	message () const
	Get the message associated with the error. More...
	operator unspecified_bool_type () const
	Operator returns non-null if there is a non-success error code. More...
bool	operator! () const
	Operator to test if the error represents success. More...

Static Public Member Functions
static void	unspecified_bool_true (unspecified_bool_type_t)

Friends
bool	operator== (const error_code &e1, const error_code &e2)
	Equality operator to compare two error objects. More...
bool	operator!= (const error_code &e1, const error_code &e2)
	Inequality operator to compare two error objects. More...

Detailed Description

Class to represent an error code value.

Definition at line 80 of file error_code.hpp.

Member Typedef Documentation

typedef void(* asio::error_code::unspecified_bool_type) (unspecified_bool_type_t)

Definition at line 126 of file error_code.hpp.

Constructor & Destructor Documentation

asio::error_code::error_code ( )

inline

Default constructor.

Definition at line 84 of file error_code.hpp.

asio::error_code::error_code ( int  v, const error_category &  c  )

inline

Construct with specific error code and category.

Definition at line 91 of file error_code.hpp.

template<typename ErrorEnum >

asio::error_code::error_code ( ErrorEnum  e )

inline

Construct from an error code enum.

Definition at line 99 of file error_code.hpp.

Member Function Documentation

const error_category& asio::error_code::category ( ) const

inline

Get the error category.

Definition at line 111 of file error_code.hpp.

std::string asio::error_code::message ( ) const

inline

Get the message associated with the error.

Definition at line 117 of file error_code.hpp.

asio::error_code::operator unspecified_bool_type ( ) const

inline

Operator returns non-null if there is a non-success error code.

Definition at line 131 of file error_code.hpp.

bool asio::error_code::operator! ( ) const

inline

Operator to test if the error represents success.

Definition at line 140 of file error_code.hpp.

static void asio::error_code::unspecified_bool_true ( unspecified_bool_type_t  )

inlinestatic

Definition at line 128 of file error_code.hpp.

int asio::error_code::value ( ) const

inline

Get the error value.

Definition at line 105 of file error_code.hpp.

Friends And Related Function Documentation

bool operator!= ( const error_code &  e1, const error_code &  e2  )

friend

Inequality operator to compare two error objects.

Definition at line 152 of file error_code.hpp.

bool operator== ( const error_code &  e1, const error_code &  e2  )

friend

Equality operator to compare two error objects.

Definition at line 146 of file error_code.hpp.

---

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

• /home/martin/ver/3DLab/code/asio-1.10.6/include/asio/error_code.hpp