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

PacketSize Property

The size of the packet to send as the ping request.

Syntax

 ping.getPacketSize([callback])
 ping.setPacketSize( packetSize, [callback])

Default Value

64


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 getPacketSize([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 setPacketSize([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 allows you to control the size of the data packet sent in the PingHost method. The default packet size is 64 bytes, with a minimum of 8 bytes (4 bytes of the ICMP header + ECHO identifier). The maximum value is 65520.

Data Type

Integer

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