WebSocketTransport class

Coordination over a WebSocket relay hub.

Works on the VM and in the browser: package:web_socket_channel presents one API over both, and nothing here touches dart:io. Run the hub with package:peer_coordinator/hub.dart (server-side) or dart run peer_coordinator:hub.

Every stream on a node shares one socket; endpoints are demultiplexed by the hub-assigned slot carried in each frame.

Inheritance

• Object
• ManagedResource
• WebSocketTransport

Implemented types

• ITransport<WebSocketTransportConfig>
• IAuthenticatedTransport
• IResourceManager

Constructors

WebSocketTransport(WebSocketTransportConfig config)

Properties

clockOffsets → PeerClockOffsets

Peer clock offsets for this process.

final

config → WebSocketTransportConfig

final

connection → WsConnection

The socket this node holds to the hub.

no setter

created → bool

Indicates whether the ILifecycle implementation has been created.

no setter, inherited

description → String

Returns a description of the identity.

no setter, override

disposed → bool

Indicates whether the ILifecycle implementation has been disposed.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

Returns a unique identifier for the identity.

final, inherited

initialized → bool

Indicates whether the required initialization has been completed.

no setter, override

localNodeUId ← String

Set by PeerSession before initialize.

no getter, override

manager → IResourceManager?

gets the resource manager that manages this resource

no setter, inherited

name → String

Returns a human-readable name for the identity.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shadowUId ↔ String?

getter/setter pair, inherited

streamFactory → NetworkStreamFactory<CoordinationSession>

Builds this transport's streams.

no setter, override

uId → String

Returns a unique identifier that is guaranteed to be globally unique.

no setter, inherited

Methods

create() → FutureOr<void>

Marks the resource created.

inherited

createDiscovery({required NetworkStreamConfig streamConfig, required CoordinationConfig coordinationConfig, required String id}) → Future<IDiscovery>

Creates a discovery instance for finding peers on this transport.

override

dispose() → Future<void>

Disposes the ILifecycle implementation, releasing any resources.

override

initialize() → Future<void>

Initializes the lifecycle, preparing it for use.

override

manageResource<R extends IResource>(R resource) → void

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

releaseResource<R extends IResource>(String resourceId) → Future<R>

override

toString() → String

A string representation of this object.

inherited

updateManager(IResourceManager? newManager) → void

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited