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)

Implemented by

Methods

close onData openChannel supports

Methods

close

  • close(): Promise<void>

  • Returns Promise<void>

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

openChannel

  • openChannel(address): Promise<Channel<Uint8Array>>

  • Parameters

    Returns Promise<Channel<Uint8Array>>

supports

  • supports(type, address?): boolean

  • Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Methods