Class UdpInterface

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

Implements

NetInterface

Index

Constructors

Accessors

Methods

close onData openChannel supports create

Constructors

constructor

new UdpInterface(server): UdpInterface
Parameters
- server: UdpChannel
Returns UdpInterface
- Defined in packages/general/src/net/UdpInterface.ts:21

Accessors

port

get port(): number
Returns number
- Defined in packages/general/src/net/UdpInterface.ts:41

Methods

close

close(): Promise<void>
Returns Promise<void>
Implementation of NetInterface.close
- Defined in packages/general/src/net/UdpInterface.ts:45

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
Implementation of NetInterface.onData
- Defined in packages/general/src/net/UdpInterface.ts:35

openChannel

openChannel(address): Promise<UdpConnection>
Parameters
- address: ServerAddress
Returns Promise<UdpConnection>
Implementation of NetInterface.openChannel
- Defined in packages/general/src/net/UdpInterface.ts:27

supports

supports(type, address): boolean
Parameters
- type: ChannelType
- address: string
Returns boolean
Implementation of NetInterface.supports
- Defined in packages/general/src/net/UdpInterface.ts:23

`Static`create

create(network, type, port?, host?, netInterface?): Promise<UdpInterface>
Parameters
- network: Network
- type: "udp4" | "udp6"
- Optionalport: number
- Optionalhost: string
- OptionalnetInterface: string
Returns Promise<UdpInterface>
- Defined in packages/general/src/net/UdpInterface.ts:15