ClientConnected Property

This property is used to disconnect individual connections and/or show their status.

Syntax

 sshtunnel.getClientConnected(index, [callback])
 sshtunnel.setClientConnected(index,  clientConnected, [callback])

Default Value

FALSE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getClientConnected([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setClientConnected([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property is used to disconnect individual connections and/or show their status.

The ClientConnected property may be set to false to close the connection.

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

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

This property is not available at design time.

Data Type

Boolean