Class AggregateClient

java.lang.Object

ai.badmonkey.agentspaces.agent.capability.AggregateClient

public final class AggregateClient
extends Object

The typed client for aspace:cap/aggregate (spec §8, §10.5): a thin wrapper over this group's PushSumAggregate, so application code joins an aggregation epoch and reads the converging fleet average through spaces.group("g").capability(AggregateClient.class).

Resolution, by the AggregateClient.Factory: a PushSumAggregate registered locally through GroupContext.provide(...) backs the client; otherwise one is created over the group's CapabilityPipes and peer sampler and registered as this peer's provider, since every push-sum participant both pushes and receives shares. Push-sum is symmetric, so there is no consumer-only mode to resolve.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AggregateClient.Factory	Resolves AggregateClients; registered through ServiceLoader.

Method Summary

Modifier and Type	Method	Description
OptionalDouble	awaitEstimate(String epochId, Duration timeout)	Waits for the fleet's estimate of an epoch to become available: the first exchange of the peer tick's push-sum rounds.
OptionalDouble	awaitSettled(String epochId, PushSumAggregate.Settle settle, Duration timeout)	Blocks until the epoch's estimate has settled under the rule, or the timeout elapses; the procedural form of onEstimate(Predicate, PushSumAggregate.Settle, Consumer) (ISSUE-OnEstimate).
PushSumAggregate	capability()	Returns the underlying aggregator.
OptionalDouble	estimate(String epochId)	Returns the current estimate of the fleet average for an epoch.
AutoCloseable	onEstimate(Predicate<String> epochs, PushSumAggregate.Settle settle, Consumer<PushSumAggregate.Estimate> listener)	PushSumAggregate.onEstimate(Predicate, PushSumAggregate.Settle, Consumer): a listener fired once per matching epoch when it settles.
List<CapabilityAdvertisement>	providers()	Returns the current, unexpired advertisements of the aggregate capability in this group.
AggregateClient	start(String epochId, double localValue)	Joins an aggregation epoch with this peer's local value.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

start

public AggregateClient start(String epochId,
 double localValue)

Joins an aggregation epoch with this peer's local value.

Parameters:

epochId - the epoch identifier agreed among participants

localValue - this peer's contribution

Returns:

this client

awaitEstimate

public OptionalDouble awaitEstimate(String epochId,
 Duration timeout)

Waits for the fleet's estimate of an epoch to become available: the first exchange of the peer tick's push-sum rounds. Empty if none arrives within the timeout (no other participant, or the epoch never started).

Parameters:

epochId - the epoch

timeout - how long to wait

Returns:

the estimate once the exchange has run

estimate

public OptionalDouble estimate(String epochId)

Returns the current estimate of the fleet average for an epoch.

Parameters:

epochId - the epoch

Returns:

the estimate, or empty when this peer never joined the epoch

onEstimate

public AutoCloseable onEstimate(Predicate<String> epochs,
 PushSumAggregate.Settle settle,
 Consumer<PushSumAggregate.Estimate> listener)

PushSumAggregate.onEstimate(Predicate, PushSumAggregate.Settle, Consumer): a listener fired once per matching epoch when it settles.

awaitSettled

public OptionalDouble awaitSettled(String epochId,
 PushSumAggregate.Settle settle,
 Duration timeout)

Blocks until the epoch's estimate has settled under the rule, or the timeout elapses; the procedural form of onEstimate(Predicate, PushSumAggregate.Settle, Consumer) (ISSUE-OnEstimate).

providers

public List<CapabilityAdvertisement> providers()

Returns the current, unexpired advertisements of the aggregate capability in this group.

Returns:

the advertisements

capability

public PushSumAggregate capability()

Returns the underlying aggregator.