QuestDB JavaScript Client - v5.0.0
    Preparing search index...

    Interface QwpBinaryConnection

    Normalized binary connection consumed by QWP sessions.

    Adapters buffer messages until the single async iterator consumes them, so unsolicited frames such as egress SERVER_INFO cannot race session startup.

    interface QwpBinaryConnection {
        closed: Promise<QwpConnectionCloseInfo>;
        endpoint?: string | URL;
        handshake: QwpHandshakeMetadata;
        ingressDeltaSymbolDictionaryEnabled?: boolean;
        ingressSymbolDictionary?: readonly string[];
        managesIngressSenderErrors?: boolean;
        messages: AsyncIterable<Uint8Array<ArrayBufferLike>>;
        close(code?: number, reason?: string): Promise<void>;
        deprioritizeEndpoint(): void;
        getEgressMetrics(): QwpEgressTransportMetrics;
        getIngressFrameSequence(clientSequence: bigint): undefined | bigint;
        getIngressMetrics(): QwpIngressTransportMetrics;
        getPublishedFrameSequence(): bigint;
        ping(): Promise<void>;
        prepareIngressBatch(
            payloads: readonly Uint8Array<ArrayBufferLike>[],
        ): Promise<void>;
        send(payload: Uint8Array): Promise<void>;
        skipIngressClientSequence(): void;
    }
    Index

    Properties

    closed endpoint? handshake ingressDeltaSymbolDictionaryEnabled? ingressSymbolDictionary? managesIngressSenderErrors? messages

    Methods

    close deprioritizeEndpoint? getEgressMetrics? getIngressFrameSequence? getIngressMetrics? getPublishedFrameSequence? ping? prepareIngressBatch? send skipIngressClientSequence?

    Properties

    closed: Promise<QwpConnectionCloseInfo>
    endpoint?: string | URL

    Endpoint backing this connection, when supplied by its adapter.

    handshake: QwpHandshakeMetadata
    ingressDeltaSymbolDictionaryEnabled?: boolean

    False after replay dictionary persistence becomes unavailable.

    ingressSymbolDictionary?: readonly string[]

    Recovered ingress dictionary supplied by replay connections.

    managesIngressSenderErrors?: boolean

    True when the transport dispatches typed sender errors itself.

    messages: AsyncIterable<Uint8Array<ArrayBufferLike>>

    Methods

    • Internal

      Marks this endpoint as temporarily unsuitable and asks a stateful connection factory to start its next sweep at another configured endpoint.

      Returns void

    • Internal

      Resolves a session sequence to its stable replay FSN.

      Parameters

      • clientSequence: bigint

      Returns undefined | bigint

    • Internal

      Published watermark alone, for the flush path.

      Transports that expose this must keep it consistent with getIngressMetrics's publishedFrameSequence; callers fall back to the full snapshot when it is absent.

      Returns bigint

    • Internal

      Serializes a whole logical batch capacity check before its first frame is sent, preventing a deferred prefix from consuming the only space needed by its commit-bearing suffix.

      Parameters

      • payloads: readonly Uint8Array<ArrayBufferLike>[]

      Returns Promise<void>

    • Internal

      Reserves a client sequence for a split-batch suffix suppressed before send(), keeping replay ACK translation aligned with the session.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods