Equalizer  1.7.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
eq::fabric::ErrorRegistry Class Reference

The registry translating error codes to strings. More...

#include <errorRegistry.h>

+ Inheritance diagram for eq::fabric::ErrorRegistry:
+ Collaboration diagram for eq::fabric::ErrorRegistry:

Public Member Functions

EQFABRIC_API const std::string & getString (const uint32_t error) const
 
EQFABRIC_API void setString (const uint32_t error, const std::string &text)
 Set an error string for the given error code. More...
 
EQFABRIC_API void eraseString (const uint32_t error)
 Clear a given error code string. More...
 
EQFABRIC_API bool isEmpty () const
 

Detailed Description

The registry translating error codes to strings.

Applications can register custom error strings starting at eq::ERROR_CUSTOM. Error registration and erasure is not thread-safe. Equalizer registers errors only during eq::init(). It is strongly advised to register application-specific errors before eq::init() and erase them after eq::exit().

See Also
co::Error, eq::Error

Definition at line 41 of file errorRegistry.h.

Member Function Documentation

EQFABRIC_API void eq::fabric::ErrorRegistry::eraseString ( const uint32_t  error)

Clear a given error code string.

Version
1.0
EQFABRIC_API const std::string& eq::fabric::ErrorRegistry::getString ( const uint32_t  error) const
Returns
the error string for the given error code.
Version
1.0
EQFABRIC_API void eq::fabric::ErrorRegistry::setString ( const uint32_t  error,
const std::string &  text 
)

Set an error string for the given error code.

Version
1.0

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