ClientIdleTimeout Property

The idle timeout for this connection.

Syntax

sshtunnel.getClientIdleTimeout(index): number
sshtunnel.setClientIdleTimeout(index, clientIdleTimeout: number)

Default Value

0

Remarks

The idle timeout for this connection. This property is similar to DefaultIdleTimeout but may be set on a per-connection basis to override DefaultIdleTimeout. This property specifies the idle timeout (in seconds) for the connected client. When set to a positive value the class will disconnect idle clients after the specified timeout.

This only applies to clients that have not send to received data within the specified number of seconds.

If set to 0 (default) no idle timeout is applied.

Note: DoEvents must be called in order for the class to check existing connections.

The size of the array is controlled by the ClientCount property.

This property is not available at design time.