Setu-TS
    Preparing search index...

    Interface IRealtimeBackplane

    A publish/subscribe transport carrying RealtimeFrames between application instances.

    const backplane = ctx.services.get<IRealtimeBackplane>(
      CAPABILITIES.REALTIME_BACKPLANE,
    );
    await backplane.subscribe((frame) => {
      if (frame.kind === 'sse-channel') {
        hub.channel(frame.name).publishLocal(JSON.parse(frame.data));
      }
    });

    0.2.0

    interface IRealtimeBackplane {
        origin: string;
        close(): Promise<void>;
        connect(): Promise<void>;
        isHealthy?(): Promise<boolean>;
        publish(frame: RealtimeFrame): Promise<void>;
        subscribe(handler: RealtimeFrameHandler): Promise<() => void>;
    }

    Implemented by

    Index
    origin
    close connect isHealthy? publish subscribe
    origin: string

    This instance's identity, stamped onto every frame it publishes.

    Stable for the lifetime of the instance and distinct from every peer's.

    • Reports whether the transport's backend is reachable right now, for the plugin's health indicator.

      Optional: a transport with no meaningful liveness check omits it, and the indicator then reports only the lifecycle state.

      This answers a fact (reachability), not a policy: the indicator that consumes it owns the up/degraded/down mapping.

      Returns Promise<boolean>

      true when the backend is reachable

      0.2.0

    • Publishes a frame to every other subscribed instance.

      The frame is not delivered back to this instance's own handlers — a local broadcast has already reached local members directly, and redelivering it would double-send.

      Parameters

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods