Renci.SshNet.Session

Session

public class Session : ISession, IDisposable

Provides functionality to connect and interact with SSH server.

public Message ClientInitMessage { get; }

Gets the client init message.

public string ClientVersion { get; }

Gets or sets the client version string.

public ConnectionInfo ConnectionInfo { get; }

Gets or sets the connection info.

public bool IsConnected { get; }

Gets a value indicating whether the session is connected.

public string ServerVersion { get; }

Gets or sets the server version string.

public byte[] SessionId { get; }

Gets the session id.

public SemaphoreLight SessionSemaphore { get; }

Gets the session semaphore that controls session channels.

public event EventHandler<MessageEventArgs<ChannelCloseMessage>> ChannelCloseReceived

Occurs when ChannelCloseMessage message received

public event EventHandler<MessageEventArgs<ChannelDataMessage>> ChannelDataReceived

Occurs when ChannelDataMessage message received

public event EventHandler<MessageEventArgs<ChannelEofMessage>> ChannelEofReceived

Occurs when ChannelEofMessage message received

public event EventHandler<MessageEventArgs<ChannelExtendedDataMessage>> ChannelExtendedDataReceived

Occurs when ChannelExtendedDataMessage message received

public event EventHandler<MessageEventArgs<ChannelFailureMessage>> ChannelFailureReceived

Occurs when ChannelFailureMessage message received

public event EventHandler<MessageEventArgs<ChannelOpenConfirmationMessage>> ChannelOpenConfirmationReceived

Occurs when ChannelOpenConfirmationMessage message received

public event EventHandler<MessageEventArgs<ChannelOpenFailureMessage>> ChannelOpenFailureReceived

Occurs when ChannelOpenFailureMessage message received

public event EventHandler<MessageEventArgs<ChannelOpenMessage>> ChannelOpenReceived

Occurs when ChannelOpenMessage message received

public event EventHandler<MessageEventArgs<ChannelRequestMessage>> ChannelRequestReceived

Occurs when ChannelRequestMessage message received

public event EventHandler<MessageEventArgs<ChannelSuccessMessage>> ChannelSuccessReceived

Occurs when ChannelSuccessMessage message received

public event EventHandler<MessageEventArgs<ChannelWindowAdjustMessage>> ChannelWindowAdjustReceived

Occurs when ChannelWindowAdjustMessage message received

public event EventHandler<EventArgs> Disconnected

Occurs when session has been disconnected from the server.

public event EventHandler<ExceptionEventArgs> ErrorOccured

Occurs when an error occurred.

public event EventHandler<HostKeyEventArgs> HostKeyReceived

Occurs when host key received.

public event EventHandler<MessageEventArgs<RequestFailureMessage>> RequestFailureReceived

Occurs when RequestFailureMessage message received

public event EventHandler<MessageEventArgs<RequestSuccessMessage>> RequestSuccessReceived

Occurs when RequestSuccessMessage message received

public event EventHandler<MessageEventArgs<BannerMessage>> UserAuthenticationBannerReceived

Occurs when BannerMessage message is received from the server.

public void Connect()

Connects to the server.

public void Disconnect()

Disconnects from the server.

public void Dispose()

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

protected virtual void Dispose(bool disposing)

Releases unmanaged and - optionally - managed resources

public void RegisterMessage(string messageName)

Registers SSH message with the session.

public void UnRegisterMessage(string messageName)

Unregister SSH message from the session.