Diffusion .NET Classic API - Core and Common  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector Interface Reference

The interface for Diffusion connections. More...

Inheritance diagram for PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector:
PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionListenerBase PushTechnology.DiffusionCore.Connection.IDiffusionTopicConnector

Public Member Functions

void Connect ()
 Attempts to establish a connection to a Diffusion server. More...
 
void Connect (EventHandler< MessageEventArgs< TopicMessageImpl >> successEvent, EventHandler< ServerClosedEventArgs > failureEvent, EventHandler< ServerClosedEventArgs > disconnectedEvent, EventHandler< MessageEventArgs< TopicMessageImpl >> messageReceivedEvent)
 Attempts to establish a connection to a Diffusion server with callbacks. More...
 
void Reconnect ()
 Attempts to re-establish a connection to a Diffusion server. More...
 
void Disconnect ()
 Closes the connection to the Diffusion server. More...
 

Properties

V4Credentials Credentials [get, set]
 Get/set the credentials. More...
 
IConnectionDetails ConnectionDetails [get, set]
 Get/set the connection details. More...
 
IServerDetails ActiveServerDetails [get]
 Get the server details object currently in use. More...
 
int MaxPacketSize [get, set]
 Get/set the maximum packet size. More...
 
bool IsConnected [get]
 Returns whether this connector is connected to a Diffusion server. More...
 
string ClientId [get]
 Gets the client Id. More...
 
ConnectionCapabilities Capabilities [get, set]
 Get/set the connection capabilities. More...
 
- Properties inherited from PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionListenerBase
ReadOnlyCollection
< IServerConnectionListener
ServerConnectionListeners [get]
 Get/set the server listeners. More...
 
IServerPingResponseListener PingListener [get, set]
 Get/set the ping listener. More...
 
IServerAckListener AckListener [get, set]
 Get/set the ack listener. More...
 

Detailed Description

The interface for Diffusion connections.

Member Function Documentation

void PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector.Connect ( )

Attempts to establish a connection to a Diffusion server.

void PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector.Connect ( EventHandler< MessageEventArgs< TopicMessageImpl >>  successEvent,
EventHandler< ServerClosedEventArgs failureEvent,
EventHandler< ServerClosedEventArgs disconnectedEvent,
EventHandler< MessageEventArgs< TopicMessageImpl >>  messageReceivedEvent 
)

Attempts to establish a connection to a Diffusion server with callbacks.

Parameters
successEventThe event invoked when connection is successful.
failureEventThe event invoked when the connection attempt has failed.
disconnectedEventThe event invoked when connection has been lost.
messageReceivedEventThe event invoked when a message is received from the Diffusion server.
void PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector.Disconnect ( )

Closes the connection to the Diffusion server.

void PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector.Reconnect ( )

Attempts to re-establish a connection to a Diffusion server.

Property Documentation

IServerDetails PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector.ActiveServerDetails
get

Get the server details object currently in use.

ConnectionCapabilities PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector.Capabilities
getset

Get/set the connection capabilities.

string PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector.ClientId
get

Gets the client Id.

IConnectionDetails PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector.ConnectionDetails
getset

Get/set the connection details.

V4Credentials PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector.Credentials
getset

Get/set the credentials.

bool PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector.IsConnected
get

Returns whether this connector is connected to a Diffusion server.

int PushTechnology.DiffusionCore.Connection.Connectors.IDiffusionBaseConnector.MaxPacketSize
getset

Get/set the maximum packet size.