HopTimeout Property

Maximum amount of time to wait for an individual hop to complete.

Syntax

 traceroute.getHopTimeout([callback])
 traceroute.setHopTimeout( hopTimeout, [callback])

Default Value

10

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 getHopTimeout([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 setHopTimeout([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

The time value is in seconds. If 0, HopTimeout will be ignored, and only the Timeout for the whole trace will be taken into account.

Data Type

Integer