Collapse All Expand All | Language Filter: C#Language Filter: Visual Basic Language Filter: Visual C++ C# Visual Basic Visual C++ | Members | See Also
StreamBase Client API
MultiConnectionConfig Class

Configures a ILiveViewMultiConnection (a connection to multiple LiveView servers with failover support). See GetConnection(MultiConnectionConfig, Boolean)

Namespace: StreamBase.LiveView.API
Assembly: StreamBase.LiveView.API (in StreamBase.LiveView.API.dll) Version: 10.3.0.4 (10.3.0.4)

# Syntax

| C# |  |  | Visual Basic |  |  | Visual C++ |

    public class MultiConnectionConfig

    Public Class MultiConnectionConfig

    public ref class MultiConnectionConfig

# Members

| All Members |  |  | Constructors |  |  | Properties |  |  | Methods |  |  | Events |

Public Protected | Instance Static | Declared Inherited | XNA Framework Only .NET Compact Framework Only |

| Member | Description
--- | --- | ---
| MultiConnectionConfig(List<(Of <<'(ConnectionConfig>)>>)) | Use this constructor to configure the servers differently. The primary use for this is to specify different username/password for the different servers, or any other specific settings per server.
| MultiConnectionConfig(List<(Of <<'(LiveViewURI>)>>), String, String) | Use this constructor to configure all the servers identically, using the given username/password (if non-null).
| ConnectionEstablishedEvent | Fired whenever any connection succeeds, including the very first one. After a roughFailover, the first server to which a successful connection is made will become the primary, and any active queries will be resubmitted to it.
| CurrentConnectionMode | The active connection mode. Default is ConnectionMode.SIMULTANEOUS_CONNECT_SINGLE_ACTIVE.
| Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.)
| GetType()()()() | Gets the Type of the current instance. (Inherited from Object.)
| MaxRandomReconnectDelay | When any connection with queries is lost, The LiveViewMultiConnection will wait a random amount of time from 0 to this value (in seconds) before trying to reconnect those queries to another server. The purpose is that when one server with many clients goes down, it will prevent the client from all trying to reconnect to one server all at the same time. Some clients will be delayed, rather than all clients plus the clients already connected to the secondary server being delayed.
| ReconnectFailedEvent | Fired whenever an attempt to make a connection fails. Note that this is, by definition, not the primary connection, because it was already known to be in a failed state. That is, a SmoothFailoverEvent or SmoothFailoverEvent was previously fired call if this was the primary connection, or a SecondaryConnectionLostEvent if this was a successful secondary connection. Or this server was never connected to before.
| RetryIntervalMS | Time to wait before making another connection attempt, in milliseconds. Default == 1000.
| RoughFailoverEvent | Fired when the current server has failed and there is no other server ready to fail over to. This will be called just before the process of resubmitting all the queries to the new primary server. If you do not want the queries to be resubmitted, you can close all the queries before returning from this call.
| SecondaryConnectionLostEvent | Fired whenever one of the secondary connections has been lost. Since the primary connection is still working fine this is just for information purposes. Nothing will happen to any ongoing queries.
| SmoothFailoverEvent | Fired when the current server has failed, but there is already another server ready to fail over to. The system is already trying to connect to other servers in the list. However, it will not resubmit any queries until this call has completed. If you do not want the queries to be resubmitted, you can close all the queries before returning from this call.
| TimeoutMS | Time before giving up on a connection attempt, in milliseconds. -1 == forever (the default).
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.)

# Inheritance Hierarchy

System..::..Object
StreamBase.LiveView.API..::..MultiConnectionConfig

# See Also

StreamBase.LiveView.API Namespace