The reason provided with More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Callbacks.ErrorReason:

Public Member Functions
override string	ToString ()
	Returns a string that represents the current object. More...

bool	Equals (ErrorReason other)
	Indicates whether the current object is equal to another object of the same type. More...

override bool	Equals (object obj)
	Determines whether the specified T:System.Object is equal to the current T:System.Object. More...

override int	GetHashCode ()
	Serves as a hash function for a particular type. More...

Static Public Member Functions
static bool	operator== (ErrorReason left, ErrorReason right)
	Override of the equality operator. More...

static bool	operator!= (ErrorReason left, ErrorReason right)
	Override of the unequality operator. More...

Static Public Attributes
static readonly ErrorReason	COMMUNICATION_FAILURE
	Communication with the server failed. More...

static readonly ErrorReason	SESSION_CLOSED
	Communication with the server failed because the session is closed. More...

static readonly ErrorReason	REQUEST_TIME_OUT
	Communication with the server failed because a service request timed out. More...

static readonly ErrorReason	ACCESS_DENIED
	The request was rejected because the caller has insufficient permissions. More...

static readonly ErrorReason	CALLBACK_EXCEPTION
	An application callback threw an exception. Check logs for more information. More...

static readonly ErrorReason	TOPIC_TREE_REGISTRATION_CONFLICT
	A conflicting, pre-existing registration exists on the same branch of the topic tree. More...

Properties
int	ReasonCode `[get]`
	A code that uniquely identifies this reason More...

Detailed Description

The reason provided with

OnError to a client side object.

An application can check whether an ErrorReason is equal to some expected value using object.Equals(object). Equality is derived from the ReasonCode, with instances with equal codes considered equal.

Some common ErrorReason values are defined as constants in this class. More specific reasons may be defined by individual features.

Member Function Documentation

bool PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.Equals ( ErrorReason other )

Indicates whether the current object is equal to another object of the same type.

Returns: true if the current object is equal to the other parameter; otherwise, false.

Parameters

other An object to compare with this object.

override bool PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.Equals ( object obj )

Determines whether the specified T:System.Object is equal to the current T:System.Object.

Returns: true if the specified T:System.Object is equal to the current T:System.Object; otherwise, false.

Parameters

obj	The object to compare with the current object.

override int PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.GetHashCode ( )

Serves as a hash function for a particular type.

Returns: A hash code for the current T:System.Object.

static bool PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.operator!=	(	ErrorReason	left,
		ErrorReason	right
	)

static

Override of the unequality operator.

Parameters

left
right

Returns

static bool PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.operator==	(	ErrorReason	left,
		ErrorReason	right
	)

static

Override of the equality operator.

Parameters

left
right

Returns

override string PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.ToString ( )

Returns a string that represents the current object.

Returns: A string that represents the current object.

Member Data Documentation

readonly ErrorReason PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.ACCESS_DENIED

static

Initial value:

=

new ErrorReason(103, Resources.ErrorReason_ACCESS_DENIED_Access_denied)

The request was rejected because the caller has insufficient permissions.

readonly ErrorReason PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.CALLBACK_EXCEPTION

static

Initial value:

=

new ErrorReason( 105, "An application callback threw an exception. Check logs for more information." )

An application callback threw an exception. Check logs for more information.

Since 5.9

readonly ErrorReason PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.COMMUNICATION_FAILURE

static

Initial value:

=

new ErrorReason(100, Resources.ErrorReason_COMMUNICATION_FAILURE_Communication_with_server_failed)

Communication with the server failed.

readonly ErrorReason PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.REQUEST_TIME_OUT

static

Initial value:

=

new ErrorReason(102, Resources.ErrorReason_REQUEST_TIME_OUT_Request_time_out)

Communication with the server failed because a service request timed out.

readonly ErrorReason PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.SESSION_CLOSED

static

Initial value:

=

new ErrorReason(101, Resources.ErrorReason_SESSION_CLOSED_Session_is_closed)

Communication with the server failed because the session is closed.

readonly ErrorReason PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.TOPIC_TREE_REGISTRATION_CONFLICT

static

Initial value:

=
            new ErrorReason(200,
                Resources.ErrorReason_TOPIC_TREE_REGISTRATION_CONFLICT_existing_registration)

A conflicting, pre-existing registration exists on the same branch of the topic tree.

Property Documentation

int PushTechnology.ClientInterface.Client.Callbacks.ErrorReason.ReasonCode

get

A code that uniquely identifies this reason

Applications should rarely need to call this method and prefer Equals(object) to compare instances for equality.

Reasons defined by Push Technology have reason codes in the range 0 to 65535 inclusive.

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

UCIStack/Client/Callbacks/ErrorReason.cs

Public Member Functions

Static Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation