All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | Friends
asio::error_code Class Reference

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

#include <error_code.hpp>

List of all members.

Classes

struct  unspecified_bool_type_t

Public Types

typedef void(* unspecified_bool_type )(unspecified_bool_type_t)
typedef int value_type
 The underlying representation of an error code.

Public Member Functions

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

Static Public Member Functions

static void unspecified_bool_true (unspecified_bool_type_t)

Private Attributes

error_category category_
value_type value_

Friends

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

Detailed Description

Class to represent an error code value.

Definition at line 69 of file error_code.hpp.


Member Typedef Documentation

Definition at line 115 of file error_code.hpp.

The underlying representation of an error code.

Definition at line 73 of file error_code.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 76 of file error_code.hpp.

Construct with specific error code and category.

Definition at line 83 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 91 of file error_code.hpp.


Member Function Documentation

Get the error category.

Definition at line 103 of file error_code.hpp.

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

Get the message associated with the error.

asio::error_code::operator unspecified_bool_type ( ) const [inline]

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

Definition at line 122 of file error_code.hpp.

bool asio::error_code::operator! ( ) const [inline]

Operator to test if the error represents success.

Definition at line 131 of file error_code.hpp.

Definition at line 117 of file error_code.hpp.

value_type asio::error_code::value ( ) const [inline]

Get the error value.

Definition at line 97 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 143 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 137 of file error_code.hpp.


Member Data Documentation

Definition at line 153 of file error_code.hpp.

Definition at line 150 of file error_code.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Castor
Author(s): Carpe Noctem
autogenerated on Fri Nov 8 2013 11:05:40