error_condition Class Reference

Describes an endpoint error state. More...

#include <error_condition.hpp>

List of all members.

Public Member Functions

 error_condition ()
 error_condition (std::string description)
 Create an error condition with only a description.
 error_condition (std::string name, std::string description)
 Create an error condition with a name and description.
 error_condition (std::string name, std::string description, proton::value properties)
 **Unsettled API** - Create an error condition with name, description, and informational properties.
 operator bool () const
 If you are using a C++11 compiler, you may use an error_condition in boolean contexts.
bool operator! () const
 No condition set.
bool empty () const
 No condition has been set.
std::string name () const
 Condition name.
std::string description () const
 Descriptive string for condition.
value properties () const
 Extra information for condition.
std::string what () const
 Simple printable string for condition.

Detailed Description

Describes an endpoint error state.

Examples:

broker.cpp, multithreaded_client.cpp, and multithreaded_client_flow_control.cpp.


Constructor & Destructor Documentation

error_condition (  )  [inline]

Create an empty error condition.

error_condition ( std::string  description  ) 

Create an error condition with only a description.

A default name will be used ("proton:io:error").

error_condition ( std::string  name,
std::string  description,
proton::value  properties 
)

**Unsettled API** - Create an error condition with name, description, and informational properties.


Member Function Documentation

operator bool (  )  const [explicit]

If you are using a C++11 compiler, you may use an error_condition in boolean contexts.

The expression will be true if the error_condition is set.


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

Generated on 28 Nov 2017 for Qpid Proton C++ by  doxygen 1.6.1