HopLimit Property

The maximum number of hops to allow for a trace.

Syntax

 traceroute.getHopLimit([callback])
 traceroute.setHopLimit( hopLimit, [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 getHopLimit([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 setHopLimit([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 limit lengthy traces. A value of 0 indicates an unbounded trace.

Note: if the value of Timeout is 0, an unbounded trace may cause a call to TraceTo to block indefinitely. To cancel such a route trace, call Interrupt.

Data Type

Integer