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

    Interface SessionCreateOptions

    Identity, callbacks, and shared registries used to create a Session.

    interface SessionCreateOptions {
        actionRegistry?: ActionRegistry | null;
        deadline?: WireDeadline;
        headers?: ByteMapInput;
        id?: string;
        maxBufferedBytesPerStream?: number;
        maxBufferedBytesTotal?: number;
        maxBufferedMessagesPerStream?: number;
        maxBufferedMessagesTotal?: number;
        maxConcurrentNestedActions?: number;
        maxConcurrentRootActions?: number;
        maxSingleMessageSize?: number;
        nodeMap?: NodeMap;
        noStreamTimeoutMs?: number | null;
        onStreamDone?: OnSessionStreamDone;
        onStreamMessage?: OnSessionStreamMessage;
    }

    Hierarchy (View Summary)

    Index
    actionRegistry? deadline? headers? id? maxBufferedBytesPerStream? maxBufferedBytesTotal? maxBufferedMessagesPerStream? maxBufferedMessagesTotal? maxConcurrentNestedActions? maxConcurrentRootActions? maxSingleMessageSize? nodeMap? noStreamTimeoutMs? onStreamDone? onStreamMessage?
    actionRegistry?: ActionRegistry | null

    Contracts and handlers available over this connection.

    deadline?: WireDeadline

    Absolute connection deadline.

    headers?: ByteMapInput

    Connection-scoped binary headers.

    id?: string

    Stable connection id; generated when omitted.

    maxBufferedBytesPerStream?: number

    Encoded bytes buffered for any one attached stream.

    maxBufferedBytesTotal?: number

    Encoded bytes buffered across every attached stream.

    maxBufferedMessagesPerStream?: number

    Messages buffered for any one attached stream.

    maxBufferedMessagesTotal?: number

    Messages buffered across every attached stream.

    maxConcurrentNestedActions?: number

    Child action handlers allowed to run concurrently.

    maxConcurrentRootActions?: number

    Top-level action handlers allowed to run concurrently.

    maxSingleMessageSize?: number

    Maximum encoded size of one incoming wire message.

    nodeMap?: NodeMap

    Shared namespace for action port nodes.

    noStreamTimeoutMs?: number | null

    Grace period with no streams before clean half-close; null disables it.

    onStreamDone?: OnSessionStreamDone

    Callback run after one attached stream terminates.

    onStreamMessage?: OnSessionStreamMessage

    Inbound message callback, including remote half-close.

    Settings
    Member Visibility

    On This Page
    Properties