papi-dts
    Preparing search index...

    Tracks registered network event emitters, enforcing shared vs. exclusive ownership policy.

    Exported for unit-testing only; not part of the public API.

    Index

    Constructors

    Methods

    • Classify an attempt to announce (emit) an event on the network against the registry. Used to warn about misuse without blocking the announcement.

      • 'ok' — the announcement is valid: the event is multi-source (any process may announce it, whether or not it registered), or it is single-source and announced by its registrant.
      • 'unregistered' — the event is single-source and no process has registered this name centrally. Emitting a single-source event that was never registered is deprecated (it does not appear in the OpenRPC document).
      • 'foreign-single-source' — the event is single-source but is being announced by a handler that did not register it; only the registering process should emit a single-source event.

      Parameters

      • handler: unknown
      • eventName: string

      Returns "ok" | "unregistered" | "foreign-single-source"

    • Returns IterableIterator<[string, EventRegistrant[]]>

    • Whether any handler has centrally registered this event name.

      Parameters

      • eventName: string

      Returns boolean

    • Try to register an event. Returns true if accepted, false if rejected.

      • Name in MULTI_SOURCE_EVENT_NAMES (multi-source): multiple handlers may register; same handler twice rejected.
      • Name not in MULTI_SOURCE_EVENT_NAMES (single-source): first registrant wins; any subsequent registration from any handler is rejected.

      Parameters

      Returns boolean

    • Remove a registrant. Returns true if the handler had registered this event.

      Parameters

      • handler: unknown
      • eventName: string

      Returns boolean

    • Remove all event registrations for the given handler (e.g. when a websocket closes)

      Parameters

      • handler: unknown

      Returns void