Type Alias Options

Type declaration

• Optionalexclusive?: boolean

  When exclusive is set to false (the default), cluster workers will use the same underlying socket handle allowing connection handling duties to be shared. When exclusive is true; however, the handle is not shared and attempted port sharing results in an error. Creating a Socket with the reusePort option set to true causes exclusive to always be true

• Optionalhost?: string | Address4 | Address6

  The local IPv4, IPv6, or interface name to which the multicast socket is bound. If unspecified, the socket will listen to all available interfaces.

  Note: if the interface is an IPv4 or IPv6 address, the socket will only listen on that interface. If the interface is an interface name, the socket will listen to all addresses assigned to that interface.

  Note: if the interface is an IPv6 address, the socket will only listen on that interface. If the interface is an interface name, the socket will listen to all addresses assigned to that interface.

• Optionalloopback?: boolean

  When set to true, the instance will also receive outgoing multicast packets

  Default

  false
  Copy

• multicastGroup: string

  The multicast group address to join

• port: number

  The local port to which the multicast socket is bound.