method

udp.SocketHandler.data

socket: Socket<DataBinaryType>,
data: BinaryTypeList[DataBinaryType],
port: number,
address: string,
flags: ReceiveFlags
): void | Promise<void>;

Referenced types

interface Socket<DataBinaryType extends BinaryType>

  • readonly binaryType: keyof BinaryTypeList
  • readonly closed: boolean
  • readonly hostname: string
  • readonly port: number
  • multicastAddress: string,
    interfaceAddress?: string
    ): boolean;

    Join a multicast group.

    @param multicastAddress

    The multicast group address

    @param interfaceAddress

    Optional interface address to use

    @returns

    true on success

  • sourceAddress: string,
    groupAddress: string,
    interfaceAddress?: string
    ): boolean;

    Join a source-specific multicast group.

    @param sourceAddress

    The source address

    @param groupAddress

    The multicast group address

    @param interfaceAddress

    Optional interface address to use

    @returns

    true on success

  • close(): void;
  • multicastAddress: string,
    interfaceAddress?: string
    ): boolean;

    Leave a multicast group.

    @param multicastAddress

    The multicast group address

    @param interfaceAddress

    Optional interface address to use

    @returns

    true on success

  • sourceAddress: string,
    groupAddress: string,
    interfaceAddress?: string
    ): boolean;

    Leave a source-specific multicast group.

    @param sourceAddress

    The source address

    @param groupAddress

    The multicast group address

    @param interfaceAddress

    Optional interface address to use

    @returns

    true on success

  • ref(): void;
  • handler: SocketHandler<DataBinaryType>
    ): void;
  • data: Data,
    port: number,
    address: string
    ): boolean;
  • packets: readonly number | Data[]
    ): number;
  • enabled: boolean
    ): boolean;

    Enable or disable the SO_BROADCAST socket option.

    @param enabled

    Whether to enable broadcast

    @returns

    The enabled value

  • interfaceAddress: string
    ): boolean;

    Set the IP_MULTICAST_IF socket option to specify the outgoing interface for multicast packets.

    @param interfaceAddress

    The address of the interface to use

    @returns

    true on success

  • enabled: boolean
    ): boolean;

    Enable or disable the IP_MULTICAST_LOOP socket option.

    @param enabled

    Whether to enable multicast loopback

    @returns

    The enabled value

  • ttl: number
    ): number;

    Set the IP_MULTICAST_TTL socket option.

    @param ttl

    Time to live value for multicast packets

    @returns

    The TTL value

  • ttl: number
    ): number;

    Set the IP_TTL socket option.

    @param ttl

    Time to live value

    @returns

    The TTL value

  • unref(): void;

interface ReceiveFlags

Extra metadata passed to the data callback for each received datagram.

  • ipv6: boolean

    true if the datagram's source address was IPv6, false for IPv4. Reflects the packet's own sockaddr — a socket adopting an existing fd may receive packets of the other family than it was created with.

  • truncated: boolean

    true if the datagram was larger than the receive buffer and was truncated by the kernel (MSG_TRUNC). The data passed to the callback contains only the portion that fit in the buffer.