DefaultTimeout Property

An initial timeout value to be used by incoming connections.

Syntax

 sshtunnel.getDefaultTimeout([callback])
 sshtunnel.setDefaultTimeout( defaultTimeout, [callback])

Default Value

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 getDefaultTimeout([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 setDefaultTimeout([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 by the class to set the operational timeout value of all inbound connections once they are established. By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

Data Type

Integer