Function multicasts

  • multicasts(
        opts?: {
            group?: string;
            multicastLoopback?: boolean;
            multicastTtl?: number;
            port?: number;
        },
    ): Promise<UdpTransport[]>

  • Create multicast transports on every multicast-capable netif.

    Parameters

    • opts: {
          group?: string;
          multicastLoopback?: boolean;
          multicastTtl?: number;
          port?: number;
      } = {}
      • Optionalgroup?: 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.

      • OptionalmulticastLoopback?: boolean

        MulticastLoopback flag.

        Default Value

        false

        Remarks

        Changing this option is inadvisable except for unit testing.

      • OptionalmulticastTtl?: number

        Multicast TTL.

        Default Value

        1

        Remarks

        Changing this option is inadvisable except for unit testing.

      • Optionalport?: number

        Local and group port.

        Default Value

        56363

    Returns Promise<UdpTransport[]>

Settings

Member Visibility