OmnyShellHub class
An embeddable OmnyShell Hub: a TLS WebSocket endpoint wired to a HubBroker.
final hub = OmnyShellHub(config);
await hub.start();
This is the standalone Hub — it owns its listener. To host the broker on a listener someone else owns (an OmnyServer Hub, say, serving OmnyShell nodes alongside its own on one port), mount an OmnyShellHubService instead.
Constructors
- OmnyShellHub(HubConfig config)
-
Creates a hub from
config.
Properties
- audit → AuditLog
-
The audit log.
no setter
- broker → HubBroker
-
The broker that authenticates, authorizes and relays.
final
- config → HubConfig
-
The hub configuration.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isRunning → bool
-
Whether the hub is running.
no setter
- nodes → NodeRegistry
-
The node registry.
no setter
- port → int
-
The port the hub is listening on (valid after start).
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sessions → SessionRouter
-
The session routing table.
no setter
- uid → OmnyUid?
-
This hub's deterministic UID, available after start (when an
HubConfig.identityCertificate was supplied).
no setter
Methods
-
metrics(
) → Map< String, dynamic> - A point-in-time snapshot of hub metrics.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
start(
) → Future< void> - Binds the TLS endpoint and starts the liveness watchdog.
-
stop(
{bool force = true}) → Future< void> - Stops the hub and releases the endpoint.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited