MessageSubType Property

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

Syntax

 icmpport.getMessageSubType([callback])
 icmpport.setMessageSubType( messageSubType, [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 getMessageSubType([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 setMessageSubType([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 subtype of the ICMP message (part of the ICMP header). The ICMP message subtype (also referred to as 'code') is a byte value representing the message subclass. Its meaning is associated with the MessageType.

Types and subtypes for ICMP messages are defined in the various internet RFCs and other documentation associated with TCP/IP.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Node.js Edition - Version 20.0 [Build 8307]