kkrpc
    Preparing search index...

    Interface Transport<TMessage>

    Message-level transport used by RPCChannel.

    interface Transport<TMessage> {
        capabilities?: TransportCapabilities;
        close(): void;
        onClose(listener: (reason?: Error) => void): () => void;
        send(message: TMessage, transfers?: Transferable[]): void | Promise<void>;
        subscribe(listener: (message: TMessage) => void): () => void;
    }

    Type Parameters

    • TMessage
    Index

    Properties

    capabilities?: TransportCapabilities

    Optional transport capabilities used for feature negotiation.

    Methods

    • Optionally register a listener invoked at most once when the transport permanently stops delivering messages because the connection dropped (remote close or network error). It is NOT invoked for a local close(). reason is an Error for abnormal termination and undefined for a clean remote close. Registering after the transport has already closed invokes the listener asynchronously with the recorded reason. Returns an unsubscribe function.

      When present, RPCChannel uses it to reject pending requests immediately instead of waiting for their timeouts. Transports that omit it behave as before: pending requests resolve, time out, or wait for destroy().

      Parameters

      • listener: (reason?: Error) => void

      Returns () => void

    • Send one message, optionally with transferables when supported.

      Parameters

      • message: TMessage
      • Optionaltransfers: Transferable[]

      Returns void | Promise<void>