Class ForwardedPort

Namespace

Renci.SshNet

Assembly

Renci.SshNet.dll

Base class for port forwarding functionality.

public abstract class ForwardedPort : IForwardedPort, IDisposable

Inheritance

object

ForwardedPort

Implements

IForwardedPort

IDisposable

Derived

ForwardedPortDynamic

ForwardedPortLocal

ForwardedPortRemote

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ForwardedPort()

protected ForwardedPort()

Properties

IsStarted

Gets a value indicating whether port forwarding is started.

public abstract bool IsStarted { get; }

Property Value

bool

true if port forwarding is started; otherwise, false.

Methods

CheckDisposed()

Ensures the current instance is not disposed.

protected abstract void CheckDisposed()

Exceptions

ObjectDisposedException

The current instance is disposed.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

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

RaiseExceptionEvent(Exception)

Raises Exception event.

protected void RaiseExceptionEvent(Exception exception)

Parameters

exception Exception

The exception.

RaiseRequestReceived(string, uint)

Raises RequestReceived event.

protected void RaiseRequestReceived(string host, uint port)

Parameters

host string

Request originator host.

port uint

Request originator port.

Start()

Starts port forwarding.

public virtual void Start()

Exceptions

InvalidOperationException

The current ForwardedPort is already started -or- is not linked to a SSH session.

SshConnectionException

The client is not connected.

StartPort()

Starts port forwarding.

protected abstract void StartPort()

Stop()

Stops port forwarding.

public virtual void Stop()

StopPort(TimeSpan)

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

protected virtual void StopPort(TimeSpan timeout)

Parameters

timeout TimeSpan

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

Events

Closing

The Closing event occurs as the forwarded port is being stopped.

public event EventHandler Closing

Event Type

EventHandler

Exception

Occurs when an exception is thrown.

public event EventHandler<ExceptionEventArgs> Exception

Event Type

EventHandler<ExceptionEventArgs>

RequestReceived

Occurs when a port forwarding request is received.

public event EventHandler<PortForwardEventArgs> RequestReceived

Event Type

EventHandler<PortForwardEventArgs>