Timeout Property

A timeout for the class.

Syntax

 netdial.getTimeout([callback])
 netdial.setTimeout( timeout, [callback])

Default Value

60

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 getTimeout([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 setTimeout([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

If this property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If this property is set to a positive value, the class will wait for the operation to complete before returning control.

The default value for this property is 60 (seconds).

Data Type

Integer