Class ForwardedPortRemote

Namespace

Renci.SshNet

Assembly

Renci.SshNet.dll

Provides functionality for remote port forwarding.

public class ForwardedPortRemote : ForwardedPort, IForwardedPort, IDisposable

Inheritance

object

ForwardedPort

ForwardedPortRemote

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

ForwardedPortRemote(IPAddress, uint, IPAddress, uint)

Initializes a new instance of the ForwardedPortRemote class.

public ForwardedPortRemote(IPAddress boundHostAddress, uint boundPort, IPAddress hostAddress, uint port)

Parameters

boundHostAddress IPAddress

The bound host address.

boundPort uint

The bound port.

hostAddress IPAddress

The host address.

port uint

The port.

Exceptions

ArgumentNullException

boundHostAddress is null.

ArgumentNullException

hostAddress is null.

ArgumentOutOfRangeException

boundPort is greater than MaxPort.

ArgumentOutOfRangeException

port is greater than MaxPort.

ForwardedPortRemote(string, uint, string, uint)

Initializes a new instance of the ForwardedPortRemote class.

public ForwardedPortRemote(string boundHost, uint boundPort, string host, uint port)

Parameters

boundHost string

The bound host.

boundPort uint

The bound port.

host string

The host.

port uint

The port.

ForwardedPortRemote(uint, string, uint)

Initializes a new instance of the ForwardedPortRemote class.

public ForwardedPortRemote(uint boundPort, string host, uint port)

Parameters

boundPort uint

The bound port.

host string

The host.

port uint

The port.

Properties

BoundHost

Gets the bound host.

public string BoundHost { get; }

Property Value

string

BoundHostAddress

Gets the bound host.

public IPAddress BoundHostAddress { get; }

Property Value

IPAddress

BoundPort

Gets the bound port.

public uint BoundPort { get; }

Property Value

uint

Host

Gets the forwarded host.

public string Host { get; }

Property Value

string

HostAddress

Gets the forwarded host.

public IPAddress HostAddress { get; }

Property Value

IPAddress

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.

Port

Gets the forwarded port.

public uint Port { get; }

Property Value

uint

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.

~ForwardedPortRemote()

Finalizes an instance of the ForwardedPortRemote class.

protected ~ForwardedPortRemote()

StartPort()

Starts remote port forwarding.

protected override void StartPort()

StopPort(TimeSpan)

Stops remote port forwarding.

protected override void StopPort(TimeSpan timeout)

Parameters

timeout TimeSpan

The maximum amount of time to wait for the port to stop.