Interface NetInterface

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

interface NetInterface {
    close(): Promise<void>;
    onData(listener: ((socket: Channel<Uint8Array>, data: Uint8Array) => void)): Listener;
    openChannel(address: ServerAddress): Promise<Channel<Uint8Array>>;
    supports(type: ChannelType, address?: string): boolean;
}

Hierarchy (view full)

TransportInterface
- NetInterface

Implemented by

UdpInterface

Index

Methods

close onData openChannel supports

Methods

close

close(): Promise<void>
Returns Promise<void>
Inherited from TransportInterface.close
- Defined in packages/general/src/net/TransportInterface.ts:18

onData

onData(listener): Listener
Parameters
- listener: ((socket: Channel<Uint8Array>, data: Uint8Array) => void)
  - - (socket, data): void
    - Parameters
      socket: Channel<Uint8Array>
      data: Uint8Array
      Returns void
Returns Listener
Inherited from TransportInterface.onData
- Defined in packages/general/src/net/TransportInterface.ts:17

openChannel

openChannel(address): Promise<Channel<Uint8Array>>
Parameters
- address: ServerAddress
Returns Promise<Channel<Uint8Array>>
- Defined in packages/general/src/net/NetInterface.ts:17

supports

supports(type, address?): boolean
Parameters
- type: ChannelType
- Optionaladdress: string
Returns boolean
Inherited from TransportInterface.supports
- Defined in packages/general/src/net/TransportInterface.ts:19