Interface IServerTransport

Interface for server-side transports

interface IServerTransport {
    state: TransportState;
    isConnected: boolean;
    send(message): Promise<void>;
    close(reason?): Promise<void>;
    on<K>(event, listener): void;
    off<K>(event, listener): void;
    once<K>(event, listener): void;
    clients: ReadonlyMap<string, IClientConnection>;
    listen(): Promise<void>;
    onMessage(handler): void;
    onClientConnect(handler): void;
    onClientDisconnect(handler): void;
    sendTo(clientId, message): Promise<void>;
    broadcast(message): Promise<void>;
}

Hierarchy (view full)

Implemented by

Properties

state isConnected clients

Methods

send close on off once listen onMessage onClientConnect onClientDisconnect sendTo broadcast

Properties

Readonly state

state: TransportState

Current transport state

Readonly isConnected

isConnected: boolean

Whether the transport is currently connected

Readonly clients

clients: ReadonlyMap<string, IClientConnection>

Currently connected clients

Methods

send

close

  • close(reason?): Promise<void>

  • Close the transport connection

    Parameters

    • Optional reason: string

      Optional reason for closing

    Returns Promise<void>

on

  • on<K>(event, listener): void

  • Register an event listener

    Type Parameters

    Parameters

    • event: K
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns void

off

  • off<K>(event, listener): void

  • Remove an event listener

    Type Parameters

    Parameters

    • event: K
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns void

once

  • once<K>(event, listener): void

  • Register a one-time event listener

    Type Parameters

    Parameters

    • event: K
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns void

listen

onMessage

onClientConnect

onClientDisconnect

  • onClientDisconnect(handler): void

  • Register handler for client disconnections

    Parameters

    • handler: ((client, reason?) => void)
        • (client, reason?): void

        • Parameters

          Returns void

    Returns void

sendTo

broadcast

Settings

Member Visibility

Theme

On This Page

stateisConnectedclientssendcloseonoffoncelistenonMessageonClientConnectonClientDisconnectsendTobroadcast