Represents the state of the session. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Session.SessionState:

Public Types
enum	SessionStateEnum { SessionStateEnum.CONNECTING, SessionStateEnum.CONNECTION_ATTEMPT_FAILED, SessionStateEnum.CONNECTED_INITIALISING, SessionStateEnum.CONNECTED_ACTIVE, SessionStateEnum.RECOVERING_RECONNECT, SessionStateEnum.RECOVERING_FAILOVER, SessionStateEnum.CLOSED_BY_CLIENT, SessionStateEnum.CLOSED_BY_SERVER, SessionStateEnum.CLOSE_FAILED }
	Enumerations representing the state of a session. More...

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

Static Public Attributes
static readonly SessionState	CONNECTING
	The session is establishing its initial connection. More...

static readonly SessionState	CONNECTION_ATTEMPT_FAILED
	The attempt to establish a connection to a server has failed. More...

static readonly SessionState	CONNECTED_INITIALISING
	A connection with a server has been established and is being initialised. More...

static readonly SessionState	CONNECTED_ACTIVE
	There is an active connection with a server. More...

static readonly SessionState	RECOVERING_RECONNECT
	Connection with a server has been lost and the session is attempting reconnection to the same server. More...

static readonly SessionState	RECOVERING_FAILOVER
	Connection to a server has been lost and the session is attempting to fail over to another server. More...

static readonly SessionState	CLOSED_BY_CLIENT
	The session has been closed by the client. More...

static readonly SessionState	CLOSED_BY_SERVER
	The session has been closed (or rejected) by the server. More...

static readonly SessionState	CLOSE_FAILED
	The session has lost its connection to a server and could not be recovered. More...

Properties
bool	Connected `[get, set]`
	Returns the 'connected' state. More...

bool	Recovering `[get, set]`
	Returns the 'recovering' state. More...

bool	Closed `[get, set]`
	Returns the 'closed' state. More...

Detailed Description

Represents the state of the session.

Member Enumeration Documentation

enum PushTechnology.ClientInterface.Client.Session.SessionState.SessionStateEnum

Enumerations representing the state of a session.

Enumerator
CONNECTING	The session is establishing its initial connection.
CONNECTION_ATTEMPT_FAILED	The attempt to establish a connection to a server has failed.
CONNECTED_INITIALISING	A connection with a server has been established and is being initialised.
CONNECTED_ACTIVE	There is an active connection with a server.
RECOVERING_RECONNECT	Connection with a server has been lost and the session is attempting reconnection to the same server.
RECOVERING_FAILOVER	Connection to a server has been lost and the session is attempting to fail over to another server.
CLOSED_BY_CLIENT	The session has been closed by the client.
CLOSED_BY_SERVER	The session has been closed (or rejected) by the server.
CLOSE_FAILED	The session has lost its connection to a server and could not be recovered.

Member Function Documentation

override string PushTechnology.ClientInterface.Client.Session.SessionState.ToString ( )

Returns a string that represents the current object.

Returns: A string that represents the current object.

Member Data Documentation

readonly SessionState PushTechnology.ClientInterface.Client.Session.SessionState.CLOSE_FAILED

static

Initial value:

=

new SessionState(SessionStateEnum.CLOSE_FAILED, false, false, true)

The session has lost its connection to a server and could not be recovered.

readonly SessionState PushTechnology.ClientInterface.Client.Session.SessionState.CLOSED_BY_CLIENT

static

Initial value:

=

new SessionState(SessionStateEnum.CLOSED_BY_CLIENT, false, false, true)

The session has been closed by the client.

readonly SessionState PushTechnology.ClientInterface.Client.Session.SessionState.CLOSED_BY_SERVER

static

Initial value:

=

new SessionState(SessionStateEnum.CLOSED_BY_SERVER, false, false, true)

The session has been closed (or rejected) by the server.

readonly SessionState PushTechnology.ClientInterface.Client.Session.SessionState.CONNECTED_ACTIVE

static

Initial value:

=

new SessionState(SessionStateEnum.CONNECTED_ACTIVE, true, false, false)

There is an active connection with a server.

readonly SessionState PushTechnology.ClientInterface.Client.Session.SessionState.CONNECTED_INITIALISING

static

Initial value:

=

new SessionState(SessionStateEnum.CONNECTED_INITIALISING, true, false, false)

A connection with a server has been established and is being initialised.

readonly SessionState PushTechnology.ClientInterface.Client.Session.SessionState.CONNECTING

static

Initial value:

=

new SessionState(SessionStateEnum.CONNECTING, false, false, false)

The session is establishing its initial connection.

readonly SessionState PushTechnology.ClientInterface.Client.Session.SessionState.CONNECTION_ATTEMPT_FAILED

static

Initial value:

=

new SessionState(SessionStateEnum.CONNECTION_ATTEMPT_FAILED, false, false, true)

The attempt to establish a connection to a server has failed.

readonly SessionState PushTechnology.ClientInterface.Client.Session.SessionState.RECOVERING_FAILOVER

static

Initial value:

=

new SessionState(SessionStateEnum.RECOVERING_FAILOVER, false, true, false)

Connection to a server has been lost and the session is attempting to fail over to another server.

readonly SessionState PushTechnology.ClientInterface.Client.Session.SessionState.RECOVERING_RECONNECT

static

Initial value:

=

new SessionState(SessionStateEnum.RECOVERING_RECONNECT, false, true, false)

Connection with a server has been lost and the session is attempting reconnection to the same server.

Property Documentation

bool PushTechnology.ClientInterface.Client.Session.SessionState.Closed

getset

Returns the 'closed' state.

bool PushTechnology.ClientInterface.Client.Session.SessionState.Connected

getset

Returns the 'connected' state.

bool PushTechnology.ClientInterface.Client.Session.SessionState.Recovering

getset

Returns the 'recovering' state.

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

UCIStack/Client/Session/SessionState.cs

Public Types

Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Member Data Documentation

Property Documentation