RTCForge API Reference v1.1.1
    Preparing search index...

    Class CascadeBridge

    Realizes a CascadeTree's planned parent-to-child links as actual media pipes on a concrete media plane.

    Subscribes to the tree's LinkCreated/LinkDropped events and forwards them to a CascadePipeInterface (for example ReferenceSfuMedia) as pipeLink/unpipeLink calls, so the fan-out tree computed by the control plane becomes real inter-node forwarding. The media methods may be async; the bridge awaits them and emits CascadeBridgeEvent.PipeError on failure (rather than swallowing it), so a broken pipe is visible. Attach it before the first build(); existing links are not replayed. Call CascadeBridge.detach to tear down every pipe it established.

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    • Synchronously invokes every listener registered for event, in registration order.

      Type Parameters

      • K extends "pipeError"

      Parameters

      • event: K

        The event name to emit.

      • ...args: CascadeBridgeEvents[K]

        The argument tuple to pass to each listener, matching Events[event].

      Returns boolean

      true if at least one listener was invoked, false if there were none.

      The listener list is snapshotted before dispatch, so mutations made by handlers take effect only on subsequent emissions. Listeners are isolated: if one throws, the remaining listeners still run and the error is surfaced via console.error rather than swallowed silently (consistent with LocalMessageBus).

    • Returns the number of listeners currently registered for event.

      Type Parameters

      • K extends "pipeError"

      Parameters

      • event: K

        The event name to count listeners for.

      Returns number

      The count of registered listeners (0 if none).

    • Removes a previously registered listener for event.

      Type Parameters

      • K extends "pipeError"

      Parameters

      • event: K

        The event name the listener was registered for.

      • listener: (...args: CascadeBridgeEvents[K]) => void

        The exact function reference passed to on or once.

      Returns this

      This emitter, for chaining.

      If the listener is not currently registered, this is a no-op. Only the first matching registration is removed.

    • Registers a listener that is invoked every time event is emitted.

      Type Parameters

      • K extends "pipeError"

      Parameters

      • event: K

        The event name to listen for.

      • listener: (...args: CascadeBridgeEvents[K]) => void

        Callback invoked with the event's argument tuple.

      Returns this

      This emitter, for chaining.

    • Registers a listener that is invoked at most once: it is removed automatically before being called the first time event is emitted.

      Type Parameters

      • K extends "pipeError"

      Parameters

      • event: K

        The event name to listen for.

      • listener: (...args: CascadeBridgeEvents[K]) => void

        Callback invoked with the event's argument tuple on the next emission.

      Returns this

      This emitter, for chaining.

      Remove a pending one-time listener by passing the same function reference to off.

    • Removes listeners for a single event, or for all events.

      Parameters

      • Optionalevent: "pipeError"

        The event name to clear; if omitted, listeners for every event are removed.

      Returns this

      This emitter, for chaining.