class XrlError

All known error codes arising from XRL dispatches. More...

Definition#include <xrl_error.hh>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Static Methods

Protected Members


Detailed Description

All known error codes arising from XRL dispatches. These include underlying transport, transport location, and invocation failures.

This class can be sub-classed to provide a sub-set of the known errors, and also to append domain specific errors.

const XrlError&  OKAY ()

OKAY

[static]

The value that should be returned by functions whose execution completed normally.

const XrlError&  BAD_ARGS ()

BAD_ARGS

[static]

The value that should be returned when the arguments in an XRL do not match what the receiver expected.

const XrlError&  COMMAND_FAILED ()

COMMAND_FAILED

[static]

The value that should be returned when the command cannot be executed by Xrl Target.

const XrlError&  NO_FINDER ()

NO_FINDER

[static]

The Xrl Finder process is not running or not ready to resolve Xrl target names

const XrlError&  RESOLVE_FAILED ()

RESOLVE_FAILED

[static]

Returned when an XRL cannot be dispatched because the target name is not registered in the system.

const XrlError&  NO_SUCH_METHOD ()

NO_SUCH_METHOD

[static]

Returned when the method within the XRL is not recognized by the receiver.

const XrlError&  SEND_FAILED ()

SEND_FAILED

[static]

Returned when the underlying XRL transport mechanism fails.

const XrlError&  REPLY_TIMED_OUT ()

REPLY_TIMED_OUT

[static]

Returned when the reply is not returned within the timeout period of the underlying transport mechanism.

const XrlError&  SEND_FAILED_TRANSIENT ()

SEND_FAILED_TRANSIENT

[static]

Returned when the underlying XRL transport mechanism fails.

const XrlError&  INTERNAL_ERROR ()

INTERNAL_ERROR

[static]

An error has occurred within the XRL system. This is usually a sign of an implementation issue. This error replaces no longer existent errors of CORRUPT_XRL, CORRUPT_XRL_RESPONSE, and BAD_PROTOCOL_VERSION. The note associated with the error should contain more information.

XrlErrorCode  error_code ()

error_code

[const]

Returns: the unique identifer number associated with error.

const char*  error_msg ()

error_msg

[const]

Returns: string containing textual description of error.

const string&  note ()

note

[const]

Returns: string containing user annotation about source of error (if set).

inline string  str ()

str

[const]

Returns: string containing error_code(), error_msg(), and note().

bool  known_code (uint32_t code)

known_code

[static]

Returns: true if error_code corresponds to known error.

 XrlError ()

XrlError

 XrlError (XrlErrorCode error_code, const string& note = "")

XrlError

 XrlError (const XrlError& xe)

XrlError

 XrlError (const XrlErrlet& x, const string& note = "")

XrlError

 XrlError (const XrlErrlet*)

XrlError

const XrlErrlet* _errlet

_errlet

[protected]

string _note

_note

[protected]


Generated by: pavlin on possum.icir.org on Thu Aug 28 12:52:06 2003, using kdoc 2.0a54+XORP.