C# Class Renci.SshNet.ForwardedPort

Base class for port forwarding functionality.
Inheritance: IForwardedPort
Datei anzeigen Open project: sshnet/SSH.NET Class Usage Examples

Private Properties

Property Type Description
RaiseClosing void
Session_ErrorOccured void

Public Methods

Method Description
Start ( ) : void

Starts port forwarding.
Stop ( ) : void

Stops port forwarding.

Protected Methods

Method Description
CheckDisposed ( ) : void

Ensures the current instance is not disposed.
Dispose ( bool disposing ) : void

Releases unmanaged and - optionally - managed resources
RaiseExceptionEvent ( Exception exception ) : void

Raises Renci.SshNet.ForwardedPort.Exception event.
RaiseRequestReceived ( string host, uint port ) : void

Raises Renci.SshNet.ForwardedPort.RequestReceived event.
StartPort ( ) : void

Starts port forwarding.
StopPort ( System.TimeSpan timeout ) : void

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

Private Methods

Method Description
RaiseClosing ( ) : void

Raises the IForwardedPort.Closing event.
Session_ErrorOccured ( object sender, ExceptionEventArgs e ) : void

Handles session ErrorOccured event.

Method Details

CheckDisposed() protected abstract method

Ensures the current instance is not disposed.
The current instance is disposed.
protected abstract CheckDisposed ( ) : void
return void

Dispose() protected method

Releases unmanaged and - optionally - managed resources
protected Dispose ( bool disposing ) : void
disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources.
return void

RaiseExceptionEvent() protected method

Raises Renci.SshNet.ForwardedPort.Exception event.
protected RaiseExceptionEvent ( Exception exception ) : void
exception System.Exception The exception.
return void

RaiseRequestReceived() protected method

Raises Renci.SshNet.ForwardedPort.RequestReceived event.
protected RaiseRequestReceived ( string host, uint port ) : void
host string Request originator host.
port uint Request originator port.
return void

Start() public method

Starts port forwarding.
public Start ( ) : void
return void

StartPort() protected abstract method

Starts port forwarding.
protected abstract StartPort ( ) : void
return void

Stop() public method

Stops port forwarding.
public Stop ( ) : void
return void

StopPort() protected method

Stops port forwarding, and waits for the specified timeout until all pending requests are processed.
protected StopPort ( System.TimeSpan timeout ) : void
timeout System.TimeSpan The maximum amount of time to wait for pending requests to finish processing.
return void