Error is a container for a Spread error code and is thrown by the library in only truly exceptional circumstances. More...

#include <Error.h>

Inheritance diagram for Error:

Public Types
enum	Code { AcceptSession = ACCEPT_SESSION, IllegalSpread = ILLEGAL_SPREAD, CouldNotConnect = COULD_NOT_CONNECT, RejectQuota = REJECT_QUOTA, RejectNoName = REJECT_NO_NAME, RejectIllegalName = REJECT_ILLEGAL_NAME, RejectNotUnique = REJECT_NOT_UNIQUE, RejectVersion = REJECT_VERSION, ConnectionClosed = CONNECTION_CLOSED, RejectAuth = REJECT_AUTH, IllegalSession = ILLEGAL_SESSION, IllegalService = ILLEGAL_SERVICE, IllegalMessage = ILLEGAL_MESSAGE, IllegalGroup = ILLEGAL_GROUP, BufferTooShort = BUFFER_TOO_SHORT, GroupsTooShort = GROUPS_TOO_SHORT, MessageTooLong = MESSAGE_TOO_LONG }
	Code is not a proper enumeration, but rather a specification of constants corresponding to Spread return and error codes. More...

Public Member Functions
	Error (const int err)
	Creates an Error instance containing the spcified error code. More...

int	error () const
	Returns the error code used to create the Error. More...

void	print () const
	Prints the message corresponding to the error via SP_error. More...

Detailed Description

Error is a container for a Spread error code and is thrown by the library in only truly exceptional circumstances.

Definition at line 40 of file Error.h.

Member Enumeration Documentation

Code is not a proper enumeration, but rather a specification of constants corresponding to Spread return and error codes.

We do not document the meaning of these codes. See the Spread C API documentation to understand their meaning.

Definition at line 51 of file Error.h.

Error::Error ( const int err )

inlineexplicit

Creates an Error instance containing the spcified error code.

Parameters

err	The Spread error code.

Definition at line 81 of file Error.h.

int Error::error ( ) const

inline

Returns the error code used to create the Error.

Definition at line 87 of file Error.h.

void Error::print ( ) const

inline

Prints the message corresponding to the error via SP_error.

We'd like to give you the message as a string, but the documented Spread C API does not provide such a facility.

Definition at line 96 of file Error.h.

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