Setu-TS
    Preparing search index...

    Interface MemoryBackplaneOptions

    Options for the 'memory' arm — a real single-process transport, not a no-op. Instances sharing one process see each other; separate processes do not.

    0.2.0

    interface MemoryBackplaneOptions {
        bus?: string;
        diagnostics?: RealtimeDiagnosticsOptions;
        localNotice?: boolean;
        onHandlerError?: (error: unknown, frame: RealtimeFrame) => void;
        origin?: string;
        topic?: string;
        transport?: "memory";
    }

    Hierarchy (View Summary)

    Index
    bus?: string

    The name of the process-wide bus this instance joins. Two backplanes built with the same name exchange frames; different names are isolated, which is what keeps concurrent tests from bleeding into each other. Defaults to 'default'.

    Opt-in realtime lifecycle observations for the local diagnostics connector (M98l). Absent (the default) registers an inert disabled source and observes nothing. Not available on the 'custom' arm: an application-supplied transport is never observed.

    When set, the plugin counts, under the one approved alias, how many publications resolved or rejected (and how long the last took) and how many arriving frames reached the local handlers, after the transport's own shape and origin filters. Publication completion is transport completion, never delivery to a peer. No frame, room or channel name, payload or origin is ever observed. Validated when RealtimeBackplanePlugin(...) is called.

    0.8.0

    localNotice?: boolean

    M70n X3-4: when the resolved transport is 'memory', the plugin logs a process-local notice at register() — frames fan out only within this process, which looks like partial delivery behind more than one replica. Default true; false suppresses the notice, matching the existing scalingNotice opt-out shape on the SSE and WebSocket plugins.

    0.2.0

    onHandlerError?: (error: unknown, frame: RealtimeFrame) => void

    Receives every subscriber throw or rejection instead of default logging. Hook failures are swallowed; the bounded handlerErrors history is retained.

    0.11.0

    origin?: string

    This instance's identity, stamped on published frames so a subscriber can drop its own echoes. Defaults to a fresh runtime.uuid(), which is correct for every deployment; override only to make a test deterministic.

    topic?: string

    The broker topic / Redis channel every instance publishes and subscribes on. Defaults to 'setu-ts.realtime'. Instances must agree on it to see each other.

    transport?: "memory"

    Transport discriminant.