Session MembersSSH .NET Client Library Documentation

The Session type exposes the following members.
Methods

  NameDescription
Public methodConnect
Connects to the server.
Public methodDisconnect
Disconnects from the server
Public methodDispose 
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged ResourceMessages.
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the Session is reclaimed by garbage collection.
(Overrides OnlineObject Finalize .)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnChannelCloseReceived
Called when ChannelCloseMessage message received.
Protected methodOnChannelDataReceived
Called when ChannelDataMessage message received.
Protected methodOnChannelEofReceived
Called when ChannelCloseMessage message received.
Protected methodOnChannelExtendedDataReceived
Called when ChannelExtendedDataMessage message received.
Protected methodOnChannelFailureReceived
Called when ChannelFailureMessage message received.
Protected methodOnChannelOpenConfirmationReceived
Called when ChannelOpenConfirmationMessage message received.
Protected methodOnChannelOpenFailureReceived
Called when ChannelOpenFailureMessage message received.
Protected methodOnChannelOpenReceived
Called when ChannelOpenMessage message received.
Protected methodOnChannelRequestReceived
Called when ChannelRequestMessage message received.
Protected methodOnChannelSuccessReceived
Called when ChannelSuccessMessage message received.
Protected methodOnChannelWindowAdjustReceived
Called when ChannelWindowAdjustMessage message received.
Protected methodOnDebugReceived
Called when DebugMessage message received.
Protected methodOnDisconnectReceived
Called when DisconnectMessage received.
Protected methodOnGlobalRequestReceived
Called when GlobalRequestMessage message received.
Protected methodOnIgnoreReceived
Called when IgnoreMessage received.
Protected methodOnKeyExchangeInitReceived
Called when KeyExchangeInitMessage message received.
Protected methodOnMessageReceived
Called when Message message received.
Protected methodOnNewKeysReceived
Called when NewKeysMessage message received.
Protected methodOnRequestFailureReceived
Called when RequestFailureMessage message received.
Protected methodOnRequestSuccessReceived
Called when RequestSuccessMessage message received.
Protected methodOnServiceAcceptReceived
Called when ServiceAcceptMessage message received.
Protected methodOnServiceRequestReceived
Called when ServiceRequestMessage message received.
Protected methodOnUnimplementedReceived
Called when UnimplementedMessage message received.
Protected methodOnUserAuthenticationBannerReceived
Called when BannerMessage message received.
Protected methodOnUserAuthenticationFailureReceived
Called when FailureMessage message received.
Protected methodOnUserAuthenticationRequestReceived
Called when RequestMessage message received.
Protected methodOnUserAuthenticationSuccessReceived
Called when SuccessMessage message received.
Public methodRegisterMessage
Registers SSH Message with the session.
Public methodOnlineToString
Returns a OnlineString that represents the current OnlineObject.
(Inherited from OnlineObject.)
Public methodUnRegisterMessage
Removes SSH message from the session
Back to Top
Fields

  NameDescription
Protected fieldStatic memberMAXIMUM_PACKET_SIZE
Specifies maximum packet size defined by the protocol.
Protected fieldStatic memberMAXIMUM_PAYLOAD_SIZE
Specifies maximum payload size defined by the protocol.
Back to Top
Properties

  NameDescription
Public propertyClientInitMessage
Gets the client init message.
Public propertyClientVersion
Gets or sets the client version string.
Public propertyConnectionInfo
Gets or sets the connection info.
Public propertyIsConnected
Gets a value indicating whether socket connected.
Public propertyServerVersion
Gets or sets the server version string.
Public propertySessionId
Gets or sets the session id.
Public propertySessionSemaphore
Gets the session semaphore that controls session channels.
Back to Top
Events

  NameDescription
Public eventDisconnected
Occurs when session has been disconnected form the server.
Public eventErrorOccured
Occurs when an error occurred.
Public eventHostKeyReceived
Occurs when host key received.
Back to Top
See Also