Class ForwardedPortDynamic

Namespace

Renci.SshNet

Assembly

Renci.SshNet.dll

Provides functionality for forwarding connections from the client to destination servers via the SSH server, also known as dynamic port forwarding.

public class ForwardedPortDynamic : ForwardedPort, IForwardedPort, IDisposable

Inheritance

object

ForwardedPort

ForwardedPortDynamic

Implements

IForwardedPort

IDisposable

Inherited Members

ForwardedPort.Start()

ForwardedPort.Stop()

ForwardedPort.Dispose()

ForwardedPort.RaiseExceptionEvent(Exception)

ForwardedPort.RaiseRequestReceived(string, uint)

ForwardedPort.Closing

ForwardedPort.Exception

ForwardedPort.RequestReceived

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ForwardedPortDynamic(string, uint)

Initializes a new instance of the ForwardedPortDynamic class.

public ForwardedPortDynamic(string host, uint port)

Parameters

host string

The host.

port uint

The port.

ForwardedPortDynamic(uint)

Initializes a new instance of the ForwardedPortDynamic class.

public ForwardedPortDynamic(uint port)

Parameters

port uint

The port.

Properties

BoundHost

Gets the bound host.

public string BoundHost { get; }

Property Value

string

BoundPort

Gets the bound port.

public uint BoundPort { get; }

Property Value

uint

IsStarted

Gets a value indicating whether port forwarding is started.

public override bool IsStarted { get; }

Property Value

bool

true if port forwarding is started; otherwise, false.

Methods

CheckDisposed()

Ensures the current instance is not disposed.

protected override void CheckDisposed()

Exceptions

ObjectDisposedException

The current instance is disposed.

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

~ForwardedPortDynamic()

Finalizes an instance of the ForwardedPortDynamic class.

protected ~ForwardedPortDynamic()

StartPort()

Starts local port forwarding.

protected override void StartPort()

StopPort(TimeSpan)

Stops local port forwarding, and waits for the specified timeout until all pending requests are processed.

protected override void StopPort(TimeSpan timeout)

Parameters

timeout TimeSpan

The maximum amount of time to wait for pending requests to finish processing.