A11 TypeScript API - v0.7.0
    Preparing search index...

    Interface WireStreamOptions

    Limits applied by each endpoint of a WireStream.

    interface WireStreamOptions {
        deadline?: WireDeadline;
        maxBufferedIncomingBytes?: number;
        maxBufferedIncomingMessages?: number;
        maxSingleMessageSize?: number;
        messageTimeoutMs?: number | null;
        stickyMetadata?: boolean;
    }
    Index
    deadline? maxBufferedIncomingBytes? maxBufferedIncomingMessages? maxSingleMessageSize? messageTimeoutMs? stickyMetadata?
    deadline?: WireDeadline

    Absolute endpoint deadline, or null for none.

    maxBufferedIncomingBytes?: number

    Maximum aggregate encoded bytes waiting for the application.

    maxBufferedIncomingMessages?: number

    Maximum messages waiting for the application callback.

    maxSingleMessageSize?: number

    Maximum encoded size of one reassembled WireMessage.

    messageTimeoutMs?: number | null

    Delivery timeout for one buffered message, or null for none.

    stickyMetadata?: boolean

    Omit a fragment's mimetype when the fragment before it on the same node carried the same one, and mark the frame so the peer puts it back.

    Off by default, and a sending decision only: a receiver always expands a frame that says it was elided. Enable it when the peer is another build of this library, or any A11 endpoint that understands x-a11-sticky-metadata -- the C++ and Python runtimes do not, and would deliver chunks whose mimetype had been dropped.

    Settings
    Member Visibility

    On This Page
    Properties