SocketTools .NET Edition

SshClient.ControlCodes Enumeration

Specifies the control codes that the SshClient class may send to the server.

[Visual Basic]
Public Enum SshClient.ControlCodes
[C#]
public enum SshClient.ControlCodes

Remarks

The SshClient class uses the ControlCodes enumeration to specify the control code that should be sent to the server using the Control method. This enables an application to send control messages to the server, which can cause it to take specific actions such as simulate a terminal break or request that the key exchange be performed again. Note that some control messages are not supported by the SSH 1.0 protocol, in which case the control message is ignored.

Members

Member Name Description
controlBreak Sends a control message to the remote host which simulates a break signal on a physical terminal. This is used by some operating systems as an instruction to enter a privileged configuration mode. Note that this is not the same as sending an interrupt character such as Ctrl+C to the remote host. This control code is ignored for SSH 1.0 sessions. This is the same as calling the Break method.
controlNoop Sends a control message to the remote host, but it does not perform any operation. This is typically used by clients to prevent the server from automatically closing a session that has been idle for a long period of time.
controlEof Sends a control message to the remote host indicating that the client has finished sending data. Note that this option is normally not used with interactive terminal sessions, and should only be used when required by the server.
controlPing Sends a control message to the remote host which is used to test whether or not the remote host is responsive to the client. This is typically used by clients to attempt to detect if the connection to the remote host is still active.
controlRekey Sends a control message to the remote host requesting that the key exchange be performed again. This control code is ignored for SSH 1.0 sessions.

Requirements

Namespace: SocketTools

Assembly: SocketTools.SshClient (in SocketTools.SshClient.dll)

See Also

SocketTools Namespace