Show / Hide Table of Contents

# Class TransportFilter

Used to implement a filter on the transport layer.

##### Inheritance

System.Object
TransportFilter
DiscoveryTransport
InactivityMonitor
LoggingTransport
MutexTransport
ResponseCorrelator
WireFormatNegotiator

##### Implements

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

##### 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)
System.Object.ToString()

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

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

##### Syntax

    public class TransportFilter : ITransport, IStartable, IDisposable, IStoppable

### Constructors

| Improve this Doc View Source

#### TransportFilter(ITransport)

##### Declaration

    public TransportFilter(ITransport next)

##### Parameters

Type | Name | Description
--- | --- | ---
ITransport | next |

### Fields

| Improve this Doc View Source

#### commandHandler

##### Declaration

    protected CommandHandler commandHandler

##### Field Value

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

| Improve this Doc View Source

#### exceptionHandler

##### Declaration

    protected ExceptionHandler exceptionHandler

##### Field Value

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

| Improve this Doc View Source

#### interruptedHandler

##### Declaration

    protected InterruptedHandler interruptedHandler

##### Field Value

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

| Improve this Doc View Source

#### next

##### Declaration

    protected readonly ITransport next

##### Field Value

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

| Improve this Doc View Source

#### resumedHandler

##### Declaration

    protected ResumedHandler resumedHandler

##### Field Value

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

### Properties

| Improve this Doc View Source

#### AsyncTimeout

Timeout in milliseconds to wait for sending asynchronous messages or commands. Set to -1 for infinite timeout.

##### Declaration

    public int AsyncTimeout { 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

#### Exception

##### Declaration

    public ExceptionHandler Exception { get; set; }

##### Property Value

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

| 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

#### 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

Property 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

#### 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

#### Timeout

Timeout in milliseconds to wait for sending synchronous messages or commands. Set to -1 for infinite timeout.

##### Declaration

    public int Timeout { get; set; }

##### Property Value

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

| Improve this Doc View Source

#### WireFormat

##### Declaration

    public IWireFormat WireFormat { get; }

##### Property Value

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

### Methods

| Improve this Doc View Source

#### AsyncRequest(Command)

Method AsyncRequest

##### Declaration

    public virtual FutureResponse AsyncRequest(Command command)

##### Parameters

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

##### Returns

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

| Improve this Doc View Source

#### Dispose()

Method Dispose

##### Declaration

    public void Dispose()

| Improve this Doc View Source

#### Dispose(Boolean)

##### Declaration

    protected virtual void Dispose(bool disposing)

##### Parameters

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

| Improve this Doc View Source

#### Finalize()

##### Declaration

    protected void Finalize()

| 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

    protected virtual void OnCommand(ITransport sender, Command command)

##### Parameters

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

| Improve this Doc View Source

#### Oneway(Command)

Method Oneway

##### Declaration

    public virtual void Oneway(Command command)

##### Parameters

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

| Improve this Doc View Source

#### OnException(ITransport, Exception)

##### Declaration

    protected virtual void OnException(ITransport sender, Exception command)

##### Parameters

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

| Improve this Doc View Source

#### OnInterrupted(ITransport)

##### Declaration

    protected virtual void OnInterrupted(ITransport sender)

##### Parameters

Type | Name | Description
--- | --- | ---
ITransport | sender |

| Improve this Doc View Source

#### OnResumed(ITransport)

##### Declaration

    protected virtual void OnResumed(ITransport sender)

##### Parameters

Type | Name | Description
--- | --- | ---
ITransport | sender |

| Improve this Doc View Source

#### Request(Command)

Method Request

##### Declaration

    public virtual Response Request(Command command)

##### Parameters

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

##### Returns

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

| Improve this Doc View Source

#### Request(Command, TimeSpan)

Method Request with time out for Response.

##### Declaration

    public virtual Response Request(Command command, TimeSpan timeout)

##### Parameters

Type | Name | Description
--- | --- | ---
Command | command | A Command
System.TimeSpan | timeout | Timeout in milliseconds

##### Returns

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

| Improve this Doc View Source

#### Start()

Method Start

##### Declaration

    public virtual void Start()

| Improve this Doc View Source

#### Stop()

##### Declaration

    public virtual void Stop()

| 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

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