IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

TimeToLive Property

The maximum number of subnets that a datagram can traverse.

Syntax

 udpport.getTimeToLive([callback])
 udpport.setTimeToLive( timeToLive, [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 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

The default value for this property is 0, which tells the class to use the default TTL value of the underlying TCP/IP subsystem. Depending on the application, you can specify a value between 1 and 255.

Data Type

Integer

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0