PushTechnology.ClientInterface.Client.Session.SessionState Class Reference

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_ACTIVE, SessionStateEnum.RECOVERING_RECONNECT,   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_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	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_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.
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,
            connected: false,
            recovering: false,
            closed: 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,
            connected: false,
            recovering: false,
            closed: 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,
            connected: false,
            recovering: false,
            closed: 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,
            connected: true,
            recovering: false,
            closed: false )

There is an active connection with a server.

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

static

Initial value:

= new SessionState(
            SessionStateEnum.CONNECTING,
            connected: false,
            recovering: false,
            closed: 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,
            connected: false,
            recovering: false,
            closed: true )

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

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

static

Initial value:

= new SessionState(
            SessionStateEnum.RECOVERING_RECONNECT,
            connected: false,
            recovering: true,
            closed: 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:

• LegacyModule/Client/Session/SessionState.cs