Renci.SshNet.Session

Session

public class Session : IDisposable

Provides functionality to connect and interact with SSH server.

Documentation

protected const int MAXIMUM_PACKET_SIZE = 35000

Specifies maximum packet size defined by the protocol.

protected const int MAXIMUM_PAYLOAD_SIZE = 32768

Specifies maximum payload size defined by the protocol.

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 socket connected.

public string ServerVersion { get; }

Gets or sets the server version string.

public byte[] SessionId { get; }

Gets or sets the session id.

public SemaphoreLight SessionSemaphore { get; }

Gets the session semaphore that controls session channels.

public event EventHandler<EventArgs> Disconnected

Occurs when session has been disconnected form the server.

public event EventHandler<ExceptionEventArgs> ErrorOccured

Occurs when an error occurred.

public event EventHandler<HostKeyEventArgs> HostKeyReceived

Occurs when host key received.

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 ResourceMessages.

protected virtual void Dispose(bool disposing)

Releases unmanaged and - optionally - managed resources

protected virtual void OnChannelCloseReceived(ChannelCloseMessage message)

Called when ChannelCloseMessage message received.

protected virtual void OnChannelDataReceived(ChannelDataMessage message)

Called when ChannelDataMessage message received.

protected virtual void OnChannelEofReceived(ChannelEofMessage message)

Called when ChannelCloseMessage message received.

protected virtual void OnChannelExtendedDataReceived(ChannelExtendedDataMessage message)

Called when ChannelExtendedDataMessage message received.

protected virtual void OnChannelFailureReceived(ChannelFailureMessage message)

Called when ChannelFailureMessage message received.

protected virtual void OnChannelOpenConfirmationReceived(ChannelOpenConfirmationMessage message)

Called when ChannelOpenConfirmationMessage message received.

protected virtual void OnChannelOpenFailureReceived(ChannelOpenFailureMessage message)

Called when ChannelOpenFailureMessage message received.

protected virtual void OnChannelOpenReceived(ChannelOpenMessage message)

Called when ChannelOpenMessage message received.

protected virtual void OnChannelRequestReceived(ChannelRequestMessage message)

Called when ChannelRequestMessage message received.

protected virtual void OnChannelSuccessReceived(ChannelSuccessMessage message)

Called when ChannelSuccessMessage message received.

protected virtual void OnChannelWindowAdjustReceived(ChannelWindowAdjustMessage message)

Called when ChannelWindowAdjustMessage message received.

protected virtual void OnDebugReceived(DebugMessage message)

Called when DebugMessage message received.

protected virtual void OnDisconnectReceived(DisconnectMessage message)

Called when DisconnectMessage received.

protected virtual void OnGlobalRequestReceived(GlobalRequestMessage message)

Called when GlobalRequestMessage message received.

protected virtual void OnIgnoreReceived(IgnoreMessage message)

Called when IgnoreMessage received.

protected virtual void OnKeyExchangeInitReceived(KeyExchangeInitMessage message)

Called when KeyExchangeInitMessage message received.

protected virtual void OnMessageReceived(Message message)

Called when Message message received.

protected virtual void OnNewKeysReceived(NewKeysMessage message)

Called when NewKeysMessage message received.

protected virtual void OnRequestFailureReceived(RequestFailureMessage message)

Called when RequestFailureMessage message received.

protected virtual void OnRequestSuccessReceived(RequestSuccessMessage message)

Called when RequestSuccessMessage message received.

protected virtual void OnServiceAcceptReceived(ServiceAcceptMessage message)

Called when ServiceAcceptMessage message received.

protected virtual void OnServiceRequestReceived(ServiceRequestMessage message)

Called when ServiceRequestMessage message received.

protected virtual void OnUnimplementedReceived(UnimplementedMessage message)

Called when UnimplementedMessage message received.

protected virtual void OnUserAuthenticationBannerReceived(BannerMessage message)

Called when BannerMessage message received.

protected virtual void OnUserAuthenticationFailureReceived(FailureMessage message)

Called when FailureMessage message received.

protected virtual void OnUserAuthenticationRequestReceived(RequestMessage message)

Called when RequestMessage message received.

protected virtual void OnUserAuthenticationSuccessReceived(SuccessMessage message)

Called when SuccessMessage message received.

public void RegisterMessage(string messageName)

Registers SSH Message with the session.

public void UnRegisterMessage(string messageName)

Removes SSH message from the session