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

MessageType Property

The type of the ICMP message (part of the ICMP header).

Syntax

 icmpport.getMessageType([callback])
 icmpport.setMessageType( messageType, [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 getMessageType([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 setMessageType([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 contains the type of the ICMP message (part of the ICMP header). The ICMP message type is a byte value representing the message class. The message type defines the structure and meaning of the message data assigned to DataToSend.

Types for ICMP messages are defined in the various internet RFCs and other documentation associated with TCP/IP. The following are a few examples of ICMP message types:

0 Echo reply ('ping' reply).
3 Destination unreachable.
4 Source quench.
5 Redirect (change a route).
8 Echo request ('ping' request).
11 Time exceeded for datagram.
12 Parameter problem on datagram.
13 Timestamp request.
14 Timestamp reply.
17 Address mask request.
18 Address mask reply.

Data Type

Integer

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