Type Alias Options

Type Declaration

• Optionalexclusive?: boolean

  When false (the default), cluster workers share the same underlying socket handle. When true, the handle is not shared and attempted port sharing results in an error.

  Note: setting reusePort to true implicitly forces exclusive to true.

• Optionalhost?: string | Address4 | Address6

  The local host to bind to. Accepts an IPv4 address, IPv6 address, or a network interface name (e.g. 'eth0'). If omitted, all available interfaces are used.

  When an IP address is provided, only the matching interface is used. When an interface name is provided, all addresses assigned to that interface are used. The address family must match the multicastGroup (IPv4 group requires IPv4 host).

• OptionallinkLocalOnly?: boolean

  RFC 6762 §11 inbound origin verification (no-native-deps approximation).

  When true (the default), received messages whose source address is not on a local-link subnet of any interface this host owns (plus loopback) are dropped before the 'message' event fires. Dropped packets are surfaced via the 'drop' event with reason 'off-link'.

  Set to false for receive scenarios that legitimately cross routed segments (e.g. SSDP over Layer 3, multicast across VPN tunnels).

  True §11 wants IP_TTL === 255 on inbound, which Node's dgram.Socket does not expose; the subnet check is the interim until a native-addon receive path is available.

  Default

  true
  Copy

• Optionalloopback?: boolean

  When true, the instance will also receive its own outgoing multicast packets via the 'message' event (with fromSelf set to true).

  Default

  false
  Copy

• multicastGroup: string

  The multicast group address to join (e.g. '224.0.0.251' for IPv4).

• port: number

  The local port to which the multicast socket is bound.