Class UdpInterface

A Network interface enhances a TransportInterface with the ability to open a channel to a remote server.

Implements

Constructors

constructor

Accessors

port

Methods

close onData openChannel supports create

Constructors

constructor

Accessors

port

  • get port(): number

  • Returns number

Methods

close

  • close(): Promise<void>

  • Returns Promise<void>

onData

  • onData(listener): Listener

  • Parameters

    • listener: ((channel: Channel<Uint8Array>, messageBytes: Uint8Array) => void)
        • (channel, messageBytes): void

        • Parameters

          • channel: Channel<Uint8Array>
          • messageBytes: Uint8Array

          Returns void

    Returns Listener

openChannel

  • openChannel(address): Promise<UdpConnection>

  • Parameters

    Returns Promise<UdpConnection>

supports

  • supports(type, address): boolean

  • Parameters

    Returns boolean

Staticcreate

  • create(network, type, port?, host?, netInterface?): Promise<UdpInterface>

  • Parameters

    • network: Network
    • type: "udp4" | "udp6"
    • Optionalport: number
    • Optionalhost: string
    • OptionalnetInterface: string

    Returns Promise<UdpInterface>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods