Interface TransportInterface

A TransportInterface is a generic interface for sending and receiving data on an established incoming connection. It cannot open new connections.

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

Hierarchy (view full)

TransportInterface
- NetInterface

Index

Methods

close onData supports

Methods

close

close(): Promise<void>
Returns Promise<void>
- 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
- Defined in packages/general/src/net/TransportInterface.ts:17

supports

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

Interface TransportInterface

Hierarchy (view full)

Index

Methods

Methods

close

Returns Promise<void>

onData

Parameters

Parameters

Returns void

Returns Listener

supports

Parameters

Returns boolean

Settings

On This Page