ssrc::spread::Error Class Reference

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 ssrc::spread::Error:

[legend]

List of all members.

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, NetErrorOnSession = NET_ERROR_ON_SESSION }
	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.
int	error () const
	Returns the error code used to create the Error.
void	print () const
	Prints the message corresponding to the error via SP_error.

---

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 38 of file Error.h.

---

Member Enumeration Documentation

enum ssrc::spread::Error::Code

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.

Enumerator:

AcceptSession
IllegalSpread
CouldNotConnect
RejectQuota
RejectNoName
RejectIllegalName
RejectNotUnique
RejectVersion
ConnectionClosed
RejectAuth
IllegalSession
IllegalService
IllegalMessage
IllegalGroup
BufferTooShort
GroupsTooShort
MessageTooLong
NetErrorOnSession

Definition at line 49 of file Error.h.

---

Constructor & Destructor Documentation

ssrc::spread::Error::Error

(

const int

err

)

[inline, explicit]

Creates an Error instance containing the spcified error code.

Parameters:

err

The Spread error code.

Definition at line 76 of file Error.h.

---

Member Function Documentation

int ssrc::spread::Error::error

(

)

const [inline]

Returns the error code used to create the Error.

Returns:

The error code used to create the Error.

Definition at line 82 of file Error.h.

void ssrc::spread::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 91 of file Error.h.

---

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

• Error.h