ReceiveInterface Property

The interface with which to receive multicast packets. If empty, default is used.

Syntax

 mcast.getReceiveInterface([callback])
 mcast.setReceiveInterface( receiveInterface, [callback])

Default Value

""

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 getReceiveInterface([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 setReceiveInterface([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 is useful when there is more than one network interface, and the one used for receiving multicast datagrams is not the default. If you wish to set an interface other than the system default, provide the IP address of the interface to be set.

This property is used together with the MulticastGroup property to join one or more multicast groups. The joining is done after the class is activated by assigning proper values to MulticastGroup.

This property is not available at design time.

Data Type

String