Interface MulticastOptions

openMulticastRx and openMulticastTx options.

interface MulticastOptions {
    group?: string;
    intf: string;
    multicastLoopback?: boolean;
    multicastTtl?: number;
    port?: number;
}

Hierarchy (View Summary)

Properties

group? intf multicastLoopback? multicastTtl? port?

Properties

Optionalgroup

group?: string

Multicast group address.

Default Value

224.0.23.170

Remarks

Due to dgram.Socket API limitation, if multiple multicast UDP transports are using the same port number but different group addresses, incoming traffic may be received on all sockets regardless of the group address. This also affects multicast UDP transports in other programs such as YaNFD. To isolate the traffic, the port number must be changed.

intf

intf: string

IPv4 address of local network interface.

OptionalmulticastLoopback

multicastLoopback?: boolean

MulticastLoopback flag.

Default Value

false

Remarks

Changing this option is inadvisable except for unit testing.

OptionalmulticastTtl

multicastTtl?: number

Multicast TTL.

Default Value

1

Remarks

Changing this option is inadvisable except for unit testing.

Optionalport

port?: number

Local and group port.

Default Value

56363

Settings

Member Visibility

On This Page

Properties