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

The interface for an object that specifies the requirements for connection to a server. More...

Inheritance diagram for PushTechnology.DiffusionCore.Connection.Interfaces.IConnectionDetails:
PushTechnology.DiffusionCore.Connection.Connectors.Connection.ConnectionDetailsImpl

Properties

int ConnectionTimeout [get, set]
 Sets the default connection timeout. More...
 
V4Credentials Credentials [get, set]
 Sets the default credentials. More...
 
TopicSet Topics [get, set]
 Get/set the default topic(s) to be subscribed to upon connection. More...
 
bool AutoAcknowledging [get, set]
 Sets the default auto acknowledge flag for connections. More...
 
bool Cascading [get, set]
 Sets the 'cascading' option. More...
 
bool AutoFailover [get, set]
 Sets the 'auto failover' option. More...
 
bool LoadBalancing [get, set]
 Sets the 'load balancing' option. More...
 
List< IServerDetailsServerDetails [get, set]
 Get/set the list of ServerDetails objects to be considered when connecting. More...
 

Detailed Description

The interface for an object that specifies the requirements for connection to a server.

Such an object may identify one or more possible servers to connect to as a list of ServerDetails objects. More than one would be required if cascading, auto failover or load balancing is specified.

Values for connection timeout, credentials, topics or auto acknowledgement may be specified for use with all possible servers, although these may be overridden by explicitly specifying values to the ServerDetails.

Connection details are created using one of the ConnectionFactory methods.

Property Documentation

bool PushTechnology.DiffusionCore.Connection.Interfaces.IConnectionDetails.AutoAcknowledging
getset

Sets the default auto acknowledge flag for connections.

bool PushTechnology.DiffusionCore.Connection.Interfaces.IConnectionDetails.AutoFailover
getset

Sets the 'auto failover' option.

By default, when a connection is lost then the listener is notified and the connection simply closed. However, if 'auto failover' is specified then if a connection is lost then an automatic attempt will be made to connect using the next ServerDetails (assuming more than one was provided).

bool PushTechnology.DiffusionCore.Connection.Interfaces.IConnectionDetails.Cascading
getset

Sets the 'cascading' option.

By default, when attempting to connect using a ServerDetails, if the connection fails then the connection will be aborted. However, if the 'Cascading' option is set and more than one ServerDetails has been supplied then if a connection attempt fails then it will move on to try the next in the list.

int PushTechnology.DiffusionCore.Connection.Interfaces.IConnectionDetails.ConnectionTimeout
getset

Sets the default connection timeout.

This value is used for connections where the timeout value is not explicitly specified in the ServerDetails.

If not explicitly set, then a default value will be assumed.

The timeout value is in milliseconds.

V4Credentials PushTechnology.DiffusionCore.Connection.Interfaces.IConnectionDetails.Credentials
getset

Sets the default credentials.

This value is used for connections where credentials have not been explicitly specified in the ServerDetails.

If not explicitly set, then no credentials are provided by default on connection.

bool PushTechnology.DiffusionCore.Connection.Interfaces.IConnectionDetails.LoadBalancing
getset

Sets the 'load balancing' option.

By default, the list of ServerDetails specified will be selected in the order that they have been supplied. However, if the 'load balancing' option is set then the order of the list is randomised whenever a connect is requested.

List<IServerDetails> PushTechnology.DiffusionCore.Connection.Interfaces.IConnectionDetails.ServerDetails
getset

Get/set the list of ServerDetails objects to be considered when connecting.

If no servers have been specified, then this will return an empty list.

TopicSet PushTechnology.DiffusionCore.Connection.Interfaces.IConnectionDetails.Topics
getset

Get/set the default topic(s) to be subscribed to upon connection.

This value is used for connections where initial topics have not been explicitly specified in the ServerDetails.

If not explicitly set, then no topics are subscribed to by default on connection.