SSHConnection Type
A currently connected client.
Remarks
This type describes the connection of a client which is currently connected to the component. You may use the different fields of this type to manage the connection.
Fields
|
Connected Boolean |
Used to disconnect individual connections and/or show their status. The Connected is used to close connections. Connected also shows the status of a particular connection (connected/disconnected). How and when the connection is closed is controlled by the Linger property. Please refer to its description for more information. |
|
ConnectionId String |
An id generated by the component to identify each connection. This id is unique to this connection. |
|
LocalAddress String |
This field shows the IP address of the interface through which the connection is passing. LocalAddress is important for multihomed hosts where it can be used to find which particular network interface an individual connection is going through. |
|
RemoteHost String |
The RemoteHost shows the IP address of the remote host through which the connection is coming. The connection must be valid or an error will be fired. If the component is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution. |
|
RemotePort Integer |
The RemotePort shows the TCP port on the remote host through which the connection is coming. The connection must be valid or an error will be fired. |
|
Timeout Integer |
A timeout for the component. If the Timeout field is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If Timeout is set to a positive value, the component will wait for the operation to complete before returning control. The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive. If Timeout expires, and the operation is not yet complete, the component throws an exception. Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. Optionally, the behavior of the component may be changed to absolute timeouts, i.e. the component will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications. This behavior is controlled by the AbsoluteTimeout configuration setting. The default value for Timeout is specified by the DefaultTimeout property. |
Constructors
[VB.NET] Public SSHConnection() [C#] public SSHConnection();