Member Junction
    Preparing search index...

    Class RealtimeProxyRegistry

    Process-wide, in-memory registry of one-time realtime-proxy tickets (Global Object Store backed via BaseSingleton, so the provider driver that mints and the MJAPI proxy that consumes share the SAME instance even under bundler code duplication).

    Intentionally has no background timer: entries are pruned lazily on every Issue / Consume, so there is nothing to shut down and no IShutdownable wiring is required. Tickets are short-lived and single-use — the map never grows unbounded in practice.

    Deliberately transport-agnostic: it stores plain data (URL + optional auth + expiry) and knows nothing about websockets or any specific provider. The proxy transport lives in MJServer; the mint logic lives in the provider driver. This is the neutral shared state between them.

    It also holds relay sessions (IssueRelaySession): one ticket per realtime session that opens one fresh connection, then only resumes that present a handle the relay forwarded to that session. They live in this process's memory too, so a resume must reach the MJAPI instance that issued the session (sticky routing for REALTIME_RELAY_PATH in multi-instance deployments).

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get GlobalKey(): string

      Returns string

    • get RelaySessionCount(): number

      Current number of relay sessions that have not ended (ended ones, and those whose fresh connection never opened within its window, are pruned) — for diagnostics and tests.

      Returns number

    Methods

    • Looks up a relay session that can still take a connection, without opening one: the relay calls this at the websocket upgrade and answers 401 on null. null when the id is unknown, the session has ended or reached its connection limit, or neither a fresh open (unused, within its window) nor a resume (a forwarded handle) is left.

      Parameters

      • id: string

      Returns RealtimeRelaySessionInfo

    • The Global Object Store is a place to store global objects that need to be shared across the application. Depending on the execution environment, this could be the window object in a browser, or the global object in a node environment, or something else in other contexts. The key here is that in some cases static variables are not truly shared because it is possible that a given class might have copies of its code in multiple paths in a deployed application. This approach ensures that no matter how many code copies might exist, there is only one instance of the object in question by using the Global Object Store.

      Returns GlobalObjectStore

    • Records a resumption handle the relay is forwarding to a session's browser, so a later resume may present it. The relay calls this before the frame that carries the handle goes out. Unknown or ended sessions, empty handles and repeats are ignored; the session keeps its RELAY_HANDLE_MEMORY most recent handles.

      Parameters

      • id: string
      • handle: string

      Returns void

    • Returns the singleton instance of the class. If the instance does not exist, it is created and stored in the Global Object Store. If className is provided it will be used as part of the key in the Global Object Store, otherwise the actual class name will be used. NOTE: the class name used by default is the lowest level of the object hierarchy, so if you have a class that extends another class, the lowest level class name will be used.

      Type Parameters

      Parameters

      • this: new () => T
      • OptionalclassName: string

      Returns T