TimeToLive Property

The time to live (TTL) value for the ICMP packets sent by the class.

Syntax

 ping.getTimeToLive([callback])
 ping.setTimeToLive( timeToLive, [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 getTimeToLive([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 setTimeToLive([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 method contains the Time-To-Live (TTL) value for the ICMP packets sent by the class. The Time-to-Live (TTL) field of the ICMP packet is a counter limiting the lifetime of a packet.

Each router (or other module) that handles a packet decrements the TTL field by one or more if it holds the packet for more than one second, thus the TTL is effectively a hop count limit on how far a datagram can propagate through the Internet. When the TTL is reduced to zero (or less), the packet is discarded.

If the value of the property is set to 0, then the default TTL value of the underlying TCP/IP subsystem will be used.

This property is not available at design time.

Data Type

Integer