kinetex - v1.0.0-rc.1
    Preparing search index...

    Interface WSBackpressureInfo

    Snapshot of the WebSocket client's backpressure state. Indicates whether the outgoing buffer is saturated and the current buffer levels.

    interface WSBackpressureInfo {
        bufferedBytes: number;
        highWaterMark: number;
        lowWaterMark: number;
        isBackpressured: boolean;
    }
    Index

    Properties

    bufferedBytes: number

    Current bytes buffered across outgoing queue + pending sends.

    highWaterMark: number

    High-water mark in bytes; sending pauses when exceeded.

    lowWaterMark: number

    Low-water mark in bytes; drain() resolves when bufferedBytes falls below this.

    isBackpressured: boolean

    True when bufferedBytes >= highWaterMark.