Renci.SshNet.ISession

ISession

interface ISession : IDisposable

Provides functionality to connect and interact with SSH server.

IConnectionInfo ConnectionInfo { get; }

Gets the connection info.

bool IsConnected { get; }

Gets a value indicating whether the session is connected.

WaitHandle MessageListenerCompleted { get; }

Gets a WaitHandle that can be used to wait for the message listener loop to complete.

SemaphoreSlim SessionSemaphore { get; }

Gets the session semaphore that controls session channels.

event EventHandler<MessageEventArgs<ChannelCloseMessage>> ChannelCloseReceived

Occurs when ChannelCloseMessage message received

event EventHandler<MessageEventArgs<ChannelDataMessage>> ChannelDataReceived

Occurs when ChannelDataMessage message received

event EventHandler<MessageEventArgs<ChannelEofMessage>> ChannelEofReceived

Occurs when ChannelEofMessage message received

event EventHandler<MessageEventArgs<ChannelExtendedDataMessage>> ChannelExtendedDataReceived

Occurs when ChannelExtendedDataMessage message received

event EventHandler<MessageEventArgs<ChannelFailureMessage>> ChannelFailureReceived

Occurs when ChannelFailureMessage message received

event EventHandler<MessageEventArgs<ChannelOpenConfirmationMessage>> ChannelOpenConfirmationReceived

Occurs when ChannelOpenConfirmationMessage message received

event EventHandler<MessageEventArgs<ChannelOpenFailureMessage>> ChannelOpenFailureReceived

Occurs when ChannelOpenFailureMessage message received

event EventHandler<MessageEventArgs<ChannelOpenMessage>> ChannelOpenReceived

Occurs when ChannelOpenMessage message received

event EventHandler<MessageEventArgs<ChannelRequestMessage>> ChannelRequestReceived

Occurs when ChannelRequestMessage message received

event EventHandler<MessageEventArgs<ChannelSuccessMessage>> ChannelSuccessReceived

Occurs when ChannelSuccessMessage message received

event EventHandler<MessageEventArgs<ChannelWindowAdjustMessage>> ChannelWindowAdjustReceived

Occurs when ChannelWindowAdjustMessage message received

event EventHandler<EventArgs> Disconnected

Occurs when session has been disconnected from the server.

event EventHandler<ExceptionEventArgs> ErrorOccured

Occurs when an error occurred.

event EventHandler<HostKeyEventArgs> HostKeyReceived

Occurs when host key received.

event EventHandler<MessageEventArgs<RequestFailureMessage>> RequestFailureReceived

Occurs when RequestFailureMessage message received

event EventHandler<MessageEventArgs<RequestSuccessMessage>> RequestSuccessReceived

Occurs when RequestSuccessMessage message received

event EventHandler<SshIdentificationEventArgs> ServerIdentificationReceived

Occurs when server identification received.

event EventHandler<MessageEventArgs<BannerMessage>> UserAuthenticationBannerReceived

Occurs when BannerMessage message is received from the server.

void Connect()

Connects to the server.

Task ConnectAsync(CancellationToken cancellationToken)

Asynchronously connects to the server.

IChannelDirectTcpip CreateChannelDirectTcpip()

Create a new channel for a locally forwarded TCP/IP port.

IChannelForwardedTcpip CreateChannelForwardedTcpip(uint remoteChannelNumber, uint remoteWindowSize, uint remoteChannelDataPacketSize)

Creates a "forwarded-tcpip" SSH channel.

IChannelSession CreateChannelSession()

Create a new SSH session channel.

void Disconnect()

Disconnects from the server.

void OnDisconnecting()

Called when client is disconnecting from the server.

void RegisterMessage(string messageName)

Registers SSH message with the session.

void SendMessage(Message message)

Sends a message to the server.

bool TrySendMessage(Message message)

Sends a message to the server.

WaitResult TryWait(WaitHandle waitHandle, TimeSpan timeout, out Exception exception)

Waits for the specified to receive a signal, using a TimeSpan to specify the time interval.

WaitResult TryWait(WaitHandle waitHandle, TimeSpan timeout)

Waits for the specified to receive a signal, using a TimeSpan to specify the time interval.

void UnRegisterMessage(string messageName)

Unregister SSH message from the session.

void WaitOnHandle(WaitHandle waitHandle)

Waits for the specified handle or the exception handle for the receive thread to signal within the connection timeout.

void WaitOnHandle(WaitHandle waitHandle, TimeSpan timeout)

Waits for the specified handle or the exception handle for the receive thread to signal within the specified timeout.