Active Property

Enables or disables sending and receiving of data.

Syntax

 icmpport.getActive([callback])
 icmpport.setActive( active, [callback])

Default Value

FALSE

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 getActive([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 setActive([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

Setting this property to True makes the class create a communication endpoint (socket) which can be used for sending and receiving ICMP messages. Setting it to False destroys the socket and disables data communications.

If the UseConnection config setting is set to True, then a local association (connection) to the remote host is also created.

This property is not available at design time.

Data Type

Boolean