Skip to main content
Corvus Connection

IConnectionsApi

Interface
TheOmenDen.StreamPulse.Scripting.IConnectionsApiRead access to live connection health inside a script handler (spec 023), backed by the central connection-health monitor. Both members are failure-safe: an unexpected fault (or an unknown source name) is surfaced as a benign default (a Disconnected snapshot / false) — a read can never propagate out of a node. State is O(1); for "gateway" it is the aggregate (listening + client count), not one client. The source name is matched case-insensitively ("twitch"/"obs"/"spotify"/"gateway").

Members

2
  • GetState
    method
    ConnectionHealthSnapshot GetState(string source)
    The current health of source (state + since-when; gateway also listening + count).
  • IsConnected
    method
    bool IsConnected(string source)
    True when source is currently Connected.