Diffusion .NET Classic API - Core and Common  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.DiffusionCore.Messaging.DiffusionConnectorState Class Reference

This class represents the state of the Diffusion server. More...

Public Member Functions

 DiffusionConnectorState (ServerConnectionState?serverState=null, SocketError?socketState=null, string errorDetails=null)
 Constructor. More...
 
bool ConnectionFailed ()
 Returns whether an attempt to connect to a Diffusion server failed; this could be for a variety of reasons. More...
 
bool ServerClosedWithReset ()
 Returns whether the connection was closed with a reset. More...
 
bool ServerClosedWithCtrlC ()
 Returns whether the server was stopped with a Ctrl-C. More...
 
bool ServerConnectionClosed ()
 Returns whether the connection was closed with a null socket. More...
 

Properties

SocketError SocketState [get, set]
 Get/set the socket error. More...
 
ServerConnectionState ServerState [get, set]
 Get/set the Diffusion server connection state. More...
 
string Details [get, set]
 Get/set any details giving more information pertaining to the Diffusion server's connection state. More...
 

Detailed Description

This class represents the state of the Diffusion server.

Constructor & Destructor Documentation

PushTechnology.DiffusionCore.Messaging.DiffusionConnectorState.DiffusionConnectorState ( ServerConnectionState serverState = null,
SocketError?  socketState = null,
string  errorDetails = null 
)

Constructor.

Parameters
serverState
socketState
errorDetails

Member Function Documentation

bool PushTechnology.DiffusionCore.Messaging.DiffusionConnectorState.ConnectionFailed ( )

Returns whether an attempt to connect to a Diffusion server failed; this could be for a variety of reasons.

Returns
bool PushTechnology.DiffusionCore.Messaging.DiffusionConnectorState.ServerClosedWithCtrlC ( )

Returns whether the server was stopped with a Ctrl-C.

Returns
bool PushTechnology.DiffusionCore.Messaging.DiffusionConnectorState.ServerClosedWithReset ( )

Returns whether the connection was closed with a reset.

Returns
bool PushTechnology.DiffusionCore.Messaging.DiffusionConnectorState.ServerConnectionClosed ( )

Returns whether the connection was closed with a null socket.

Returns

Property Documentation

string PushTechnology.DiffusionCore.Messaging.DiffusionConnectorState.Details
getset

Get/set any details giving more information pertaining to the Diffusion server's connection state.

ServerConnectionState PushTechnology.DiffusionCore.Messaging.DiffusionConnectorState.ServerState
getset

Get/set the Diffusion server connection state.

SocketError PushTechnology.DiffusionCore.Messaging.DiffusionConnectorState.SocketState
getset

Get/set the socket error.