HopTime Property

The amount of time taken by a particular hop in the trace.

Syntax

 traceroute.getHopTime(index, [callback])

Default Value

0

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 getHopTime([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 setHopTime([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 amount of time taken by a particular hop in the trace. If a given hop times out, this value will be set to -1.

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

This property is read-only and not available at design time.

Data Type

Long