Show / Hide Table of Contents

# Class FailoverTransport

A Transport that is made reliable by being able to fail over to another transport when a transport failure is detected.

##### Inheritance

System.Object
FailoverTransport

##### Implements

ICompositeTransport
ITransport
Apache.NMS.IStartable
System.IDisposable
Apache.NMS.IStoppable
System.IComparable

##### Inherited Members

System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)

###### Namespace: Apache.NMS.ActiveMQ.Transport.Failover

###### Assembly: Apache.NMS.ActiveMQ.dll

##### Syntax

    public class FailoverTransport : ICompositeTransport, ITransport, IStartable, IDisposable, IStoppable, IComparable

### Constructors

| Improve this Doc View Source

#### FailoverTransport()

##### Declaration

    public FailoverTransport()

### Properties

| Improve this Doc View Source

#### AsyncConnect

Gets or sets a value indicating whether to asynchronously connect to sockets

##### Declaration

    public bool AsyncConnect { set; }

##### Property Value

Type | Description
--- | ---
System.Boolean | `true` if [async connect]; otherwise, `false`.

| Improve this Doc View Source

#### AsyncTimeout

If doing an asynchronous connect, the milliseconds before timing out if no connection can be made

##### Declaration

    public int AsyncTimeout { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 | The async timeout.

| Improve this Doc View Source

#### Backup

##### Declaration

    public bool Backup { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### BackupPoolSize

##### Declaration

    public int BackupPoolSize { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### Command

##### Declaration

    public CommandHandler Command { get; set; }

##### Property Value

Type | Description
--- | ---
CommandHandler |

| Improve this Doc View Source

#### ConnectedTransport

##### Declaration

    public ITransport ConnectedTransport { get; set; }

##### Property Value

Type | Description
--- | ---
ITransport |

| Improve this Doc View Source

#### ConnectedTransportURI

##### Declaration

    public Uri ConnectedTransportURI { get; set; }

##### Property Value

Type | Description
--- | ---
System.Uri |

| Improve this Doc View Source

#### Exception

##### Declaration

    public ExceptionHandler Exception { get; set; }

##### Property Value

Type | Description
--- | ---
ExceptionHandler |

| Improve this Doc View Source

#### InitialReconnectDelay

##### Declaration

    public int InitialReconnectDelay { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### Interrupted

##### Declaration

    public InterruptedHandler Interrupted { get; set; }

##### Property Value

Type | Description
--- | ---
InterruptedHandler |

| Improve this Doc View Source

#### IsConnected

##### Declaration

    public bool IsConnected { get; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### IsConnectedToPriority

##### Declaration

    public bool IsConnectedToPriority { get; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### IsDisposed

##### Declaration

    public bool IsDisposed { get; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### IsFaultTolerant

##### Declaration

    public bool IsFaultTolerant { get; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### IsReconnectSupported

##### Declaration

    public bool IsReconnectSupported { get; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### IsStarted

##### Declaration

    public bool IsStarted { get; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### IsUpdateURIsSupported

##### Declaration

    public bool IsUpdateURIsSupported { get; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### MaxCacheSize

##### Declaration

    public int MaxCacheSize { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### MaxReconnectAttempts

##### Declaration

    public int MaxReconnectAttempts { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### MaxReconnectDelay

##### Declaration

    public int MaxReconnectDelay { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### PriorityBackup

##### Declaration

    public bool PriorityBackup { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### PriorityURIs

##### Declaration

    public string PriorityURIs { get; set; }

##### Property Value

Type | Description
--- | ---
System.String |

| Improve this Doc View Source

#### Randomize

##### Declaration

    public bool Randomize { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### ReconnectDelay

##### Declaration

    public int ReconnectDelay { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### ReconnectDelayExponent

##### Declaration

    public int ReconnectDelayExponent { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### RemoteAddress

##### Declaration

    public Uri RemoteAddress { get; }

##### Property Value

Type | Description
--- | ---
System.Uri |

| Improve this Doc View Source

#### Resumed

##### Declaration

    public ResumedHandler Resumed { get; set; }

##### Property Value

Type | Description
--- | ---
ResumedHandler |

| Improve this Doc View Source

#### StartupMaxReconnectAttempts

##### Declaration

    public int StartupMaxReconnectAttempts { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### StateTracker

##### Declaration

    public ConnectionStateTracker StateTracker { get; }

##### Property Value

Type | Description
--- | ---
ConnectionStateTracker |

| Improve this Doc View Source

#### Timeout

##### Declaration

    public int Timeout { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### TrackMessages

##### Declaration

    public bool TrackMessages { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### TrackTransactionProducers

##### Declaration

    public bool TrackTransactionProducers { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### UseExponentialBackOff

##### Declaration

    public bool UseExponentialBackOff { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### WireFormat

##### Declaration

    public IWireFormat WireFormat { get; }

##### Property Value

Type | Description
--- | ---
IWireFormat |

### Methods

| Improve this Doc View Source

#### Add(Boolean, String)

##### Declaration

    public void Add(bool rebalance, string u)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Boolean | rebalance |
System.String | u |

| Improve this Doc View Source

#### Add(Boolean, Uri[])

##### Declaration

    public void Add(bool rebalance, Uri[] urisToAdd)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Boolean | rebalance |
System.Uri[] | urisToAdd |

| Improve this Doc View Source

#### AsyncRequest(Command)

##### Declaration

    public FutureResponse AsyncRequest(Command command)

##### Parameters

Type | Name | Description
--- | --- | ---
Command | command |

##### Returns

Type | Description
--- | ---
FutureResponse |

| Improve this Doc View Source

#### CompareTo(Object)

##### Declaration

    public int CompareTo(object o)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Object | o |

##### Returns

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### ConnectionInterruptProcessingComplete(ConnectionId)

##### Declaration

    public void ConnectionInterruptProcessingComplete(ConnectionId connectionId)

##### Parameters

Type | Name | Description
--- | --- | ---
ConnectionId | connectionId |

| Improve this Doc View Source

#### Dispose()

##### Declaration

    public void Dispose()

| Improve this Doc View Source

#### Dispose(Boolean)

##### Declaration

    public void Dispose(bool disposing)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Boolean | disposing |

| Improve this Doc View Source

#### DisposedOnCommand(ITransport, Command)

##### Declaration

    public void DisposedOnCommand(ITransport sender, Command c)

##### Parameters

Type | Name | Description
--- | --- | ---
ITransport | sender |
Command | c |

| Improve this Doc View Source

#### DisposedOnException(ITransport, Exception)

##### Declaration

    public void DisposedOnException(ITransport sender, Exception e)

##### Parameters

Type | Name | Description
--- | --- | ---
ITransport | sender |
System.Exception | e |

| Improve this Doc View Source

#### DisposeTransport(ITransport)

##### Declaration

    public void DisposeTransport(ITransport transport)

##### Parameters

Type | Name | Description
--- | --- | ---
ITransport | transport |

| Improve this Doc View Source

#### Finalize()

##### Declaration

    protected void Finalize()

| Improve this Doc View Source

#### HandleConnectionControl(ConnectionControl)

##### Declaration

    public void HandleConnectionControl(ConnectionControl control)

##### Parameters

Type | Name | Description
--- | --- | ---
ConnectionControl | control |

| Improve this Doc View Source

#### HandleTransportFailure(Exception)

##### Declaration

    public void HandleTransportFailure(Exception e)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Exception | e |

| Improve this Doc View Source

#### Narrow(Type)

##### Declaration

    public object Narrow(Type type)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Type | type |

##### Returns

Type | Description
--- | ---
System.Object |

| Improve this Doc View Source

#### OnCommand(ITransport, Command)

##### Declaration

    public void OnCommand(ITransport sender, Command command)

##### Parameters

Type | Name | Description
--- | --- | ---
ITransport | sender |
Command | command |

| Improve this Doc View Source

#### Oneway(Command)

##### Declaration

    public void Oneway(Command command)

##### Parameters

Type | Name | Description
--- | --- | ---
Command | command |

| Improve this Doc View Source

#### OnException(ITransport, Exception)

##### Declaration

    public void OnException(ITransport sender, Exception error)

##### Parameters

Type | Name | Description
--- | --- | ---
ITransport | sender |
System.Exception | error |

| Improve this Doc View Source

#### Reconnect(Boolean)

##### Declaration

    public void Reconnect(bool rebalance)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Boolean | rebalance |

| Improve this Doc View Source

#### Reconnect(Uri)

##### Declaration

    public void Reconnect(Uri uri)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Uri | uri |

| Improve this Doc View Source

#### Remove(Boolean, String)

##### Declaration

    public void Remove(bool rebalance, string u)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Boolean | rebalance |
System.String | u |

| Improve this Doc View Source

#### Remove(Boolean, Uri[])

##### Declaration

    public void Remove(bool rebalance, Uri[] u)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Boolean | rebalance |
System.Uri[] | u |

| Improve this Doc View Source

#### Request(Command)

##### Declaration

    public Response Request(Command command)

##### Parameters

Type | Name | Description
--- | --- | ---
Command | command |

##### Returns

Type | Description
--- | ---
Response |

| Improve this Doc View Source

#### Request(Command, TimeSpan)

##### Declaration

    public Response Request(Command command, TimeSpan ts)

##### Parameters

Type | Name | Description
--- | --- | ---
Command | command |
System.TimeSpan | ts |

##### Returns

Type | Description
--- | ---
Response |

| Improve this Doc View Source

#### RestoreTransport(ITransport)

##### Declaration

    protected void RestoreTransport(ITransport t)

##### Parameters

Type | Name | Description
--- | --- | ---
ITransport | t |

| Improve this Doc View Source

#### Shuffle<T>(List<T>)

##### Declaration

    public void Shuffle<T>(List<T> list)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Collections.Generic.List<T> | list |

##### Type Parameters

Name | Description
--- | ---
T |

| Improve this Doc View Source

#### Start()

##### Declaration

    public void Start()

| Improve this Doc View Source

#### Stop()

##### Declaration

    public virtual void Stop()

| Improve this Doc View Source

#### ToString()

##### Declaration

    public override string ToString()

##### Returns

Type | Description
--- | ---
System.String |

##### Overrides

System.Object.ToString()
| Improve this Doc View Source

#### UpdateURIs(Boolean, Uri[])

##### Declaration

    public void UpdateURIs(bool rebalance, Uri[] updatedURIs)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Boolean | rebalance |
System.Uri[] | updatedURIs |

### Implements

ICompositeTransport
ITransport
Apache.NMS.IStartable
System.IDisposable
Apache.NMS.IStoppable
System.IComparable