Loopback Property

Enables or disables loopback of data sent to the multicast group.

Syntax

 mcast.getLoopback([callback])
 mcast.setLoopback( loopback, [callback])

Default Value

TRUE

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 getLoopback([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 setLoopback([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 enables or disables loopback of data sent to the multicast group. Setting this property to False disables loopback of data sent through the class (normally loopback is enabled). This property is directly related to the IP_MULTICAST_LOOP socket option.

This property is not available at design time.

Data Type

Boolean

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