AngularTS
    Preparing search index...

    Interface WebTransportConfig

    Options passed to $webTransport.

    interface WebTransportConfig {
        allowPooling?: boolean;
        congestionControl?: "default" | "throughput" | "low-latency";
        maxRetries?: number;
        onClose?: () => void;
        onDatagram?: (event: WebTransportDatagramEvent) => void;
        onError?: (error: unknown) => void;
        onOpen?: () => void;
        onProtocolMessage?: (
            message: RealtimeProtocolMessage,
            event: WebTransportDatagramEvent<RealtimeProtocolMessage>,
        ) => void;
        onReconnect?: (event: WebTransportReconnectEvent) => void | Promise<void>;
        reconnect?: boolean;
        requireUnreliable?: boolean;
        retryDelay?: WebTransportRetryDelay;
        serverCertificateHashes?: WebTransportCertificateHash[];
        transformDatagram?: (data: Uint8Array) => unknown;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowPooling? congestionControl? maxRetries? onClose? onDatagram? onError? onOpen? onProtocolMessage? onReconnect? reconnect? requireUnreliable? retryDelay? serverCertificateHashes? transformDatagram?

    Properties
    allowPooling?: boolean
    congestionControl?: "default" | "throughput" | "low-latency"
    maxRetries?: number

    Maximum reconnect attempts before closed settles. Defaults to no limit.

    onClose?: () => void

    Called when the managed connection closes without another reconnect.

    onDatagram?: (event: WebTransportDatagramEvent) => void

    Called with each incoming datagram.

    onError?: (error: unknown) => void

    Called when opening, reading, writing, or closing fails.

    onOpen?: () => void

    Called whenever the current native transport resolves ready.

    onProtocolMessage?: (
        message: RealtimeProtocolMessage,
        event: WebTransportDatagramEvent<RealtimeProtocolMessage>,
    ) => void

    Called when a decoded datagram uses the realtime protocol shape.

    onReconnect?: (event: WebTransportReconnectEvent) => void | Promise<void>

    Called after a replacement session is ready so callers can renegotiate state.

    reconnect?: boolean

    Reopen the native WebTransport session when it closes unexpectedly.

    requireUnreliable?: boolean
    retryDelay?: WebTransportRetryDelay

    Delay before each reconnect attempt. Defaults to 1000ms.

    serverCertificateHashes?: WebTransportCertificateHash[]
    transformDatagram?: (data: Uint8Array) => unknown

    Converts incoming datagram bytes into the value passed as event.message.

    Settings
    Member Visibility

    On This Page
    Properties