Interface UDP

Readonly[toStringTag]

bind

• bind(addr: Record<string, any>, flags?: number): void

  Bind to address (synchronous, wraps uv_udp_bind)

  Parameters

  • addr: Record<string, any>

    Address object

  • Optionalflags: number

    Bind flags (optional)

  Returns void

close

• close(): void

  Close UDP connection (synchronous)

  Returns void

connect

• connect(addr: Record<string, any>): void

  Connect to address (synchronous, wraps uv_udp_connect)

  Parameters

  • addr: Record<string, any>

    Address object

  Returns void

fileno

• fileno(): number

  Get file descriptor (synchronous)

  Returns number

  File descriptor

getpeername

• getpeername(): Record<string, any>

  Get peer name (synchronous, wraps uv_udp_getpeername)

  Returns Record<string, any>

  Peer name object

getsockname

• getsockname(): Record<string, any>

  Get socket name (synchronous, wraps uv_udp_getsockname)

  Returns Record<string, any>

  Socket name object

recv

• recv(
      buffer: Uint8Array,
  ): Promise<{ addr: Record<string, any>; nread: number; partial: boolean }>

  Receive data (async, returns Promise)

  Parameters

  • buffer: Uint8Array

    Uint8Array to store received data

  Returns Promise<{ addr: Record<string, any>; nread: number; partial: boolean }>

  Receive info object

send

• send(buffer: Uint8Array, addr?: Record<string, any>): Promise<number>

  Send data (async, returns Promise)

  Parameters

  • buffer: Uint8Array

    Uint8Array containing data to send

  • Optionaladdr: Record<string, any>

    Target address object

  Returns Promise<number>

  Sent data length