IDiscovery class abstract interface

Finds peers on the network.

Each transport implements this over whatever mechanism it has: LSL multicast-resolves stream metadata, a hub transport asks the hub. The coordination layer only ever speaks DiscoveryQuery and PeerDescriptor.

Implemented types
Implementers

Properties

created → bool
Indicates whether the ILifecycle implementation has been created.
no setterinherited
description → String?
Returns a description of the identity.
no setterinherited
disposed → bool
Indicates whether the ILifecycle implementation has been disposed.
no setterinherited
events → Stream<DiscoveryEvent>
Peers found by the continuous discovery started with start.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String
Returns a unique identifier for the identity.
no setterinherited
manager → IResourceManager?
gets the resource manager that manages this resource
no setterinherited
name → String
Returns a human-readable name for the identity.
no setterinherited
paused → bool
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
uId → String
Returns a unique identifier that is guaranteed to be globally unique.
no setterinherited

Methods

create() → FutureOr<void>
Creates.
inherited
discoverOnce(DiscoveryQuery query, {Duration timeout = const Duration(seconds: 2), int minPeers = 0, int maxPeers = 10}) → Future<List<PeerHandle>>
Runs a single bounded discovery.
dispose() → FutureOr<void>
Disposes the ILifecycle implementation, releasing any resources.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pause() → FutureOr<void>
Pauses the implementation.
inherited
resume() → FutureOr<void>
Resumes the implementation.
inherited
start({required DiscoveryQuery query, Duration? timeout, int? maxPeers}) → void
Begins continuous discovery, reporting matches on events until stop.
stop() → void
Stops continuous discovery. Safe to call when not running.
toString() → String
A string representation of this object.
inherited
updateManager(IResourceManager? newManager) → FutureOr<void>
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited