Package utils.consensus.synchConsensusUtilities

Class ConsensusInstanceSkeleton<ConsensusAttachment>

java.lang.Object

utils.consensus.snapshot.ConsensusState

utils.consensus.synchConsensusUtilities.ConsensusInstanceSkeleton<ConsensusAttachment>

All Implemented Interfaces:

ConsensusInstance<Double>

public final class ConsensusInstanceSkeleton<ConsensusAttachment>
extends ConsensusState
implements ConsensusInstance<Double>

Field Summary

Fields

Modifier and Type	Field	Description
Double	endingV
final InstanceID	instanceID
final MessageLogger	logger
final ConsensusMetrics	metrics
final Map<Integer,CompletableFuture<double[]>>	multisetFuturePerRound
final ReentrantLock	multisetLock
final Map<Integer,List<Double>>	multisetPerRound
final RequestID	reqID
Double	startingV

Fields inherited from class utils.consensus.snapshot.ConsensusState

broadcast, epsilon, groupState, H, n, t

Constructor Summary

Constructors

Constructor	Description
ConsensusInstanceSkeleton()
ConsensusInstanceSkeleton(T snapshot, RequestID reqID, InstanceID instanceID, Double startingV, Long timeout, TimeUnit unit, Double defaultValue, ApproximateConsensusHandler<ConsensusAttachment> handler, ConsensusAttachment attachment, MessageLogger logger)
ConsensusInstanceSkeleton(RequestID reqID, InstanceID instanceID, int n, int t, double epsilon, double startingV, GroupConstitution groupState, Broadcast broadcast, Long timeout, TimeUnit unit, Double defaultValue, ApproximateConsensusHandler<ConsensusAttachment> handler, ConsensusAttachment attachment)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Double>	approximateConsensus_other(ApproximationMessage msg)	Method called when a new approximate consensus instance is started by another process.
CompletableFuture<Double>	approximateConsensus_self()	Method called when new approximate consensus instance is started by the calling process.
boolean	consensusStillPossible()	Check if necessary conditions to guarantee correctness in the execution of the algorithm are still met.
void	exchange(Byte msgType, ApproximationMessage msg, AddressInterface q)	Method called as handler of an approximation message.
Map<? extends AddressInterface,? extends ProcessInterface>	getGroupState()	Getter for the consensus instance's snapshot of the group's constitution
ConsensusMetrics	getMetrics()	Get the object containing several relevant metrics to profile the execution of this instance of consensus
RequestID	getReqID()	Getter for the unique identifier of this consensus instance.

Methods inherited from class java.lang.Object

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

Field Details

multisetPerRound

public final Map<Integer,List<Double>> multisetPerRound

multisetFuturePerRound

public final Map<Integer,CompletableFuture<double[]>> multisetFuturePerRound

multisetLock

public final ReentrantLock multisetLock

startingV

public Double startingV

endingV

public Double endingV

reqID

public final RequestID reqID

instanceID

public final InstanceID instanceID

metrics

public final ConsensusMetrics metrics

logger

public final MessageLogger logger

Constructor Details

ConsensusInstanceSkeleton

public ConsensusInstanceSkeleton()

ConsensusInstanceSkeleton

public ConsensusInstanceSkeleton(RequestID reqID,
 InstanceID instanceID,
 int n,
 int t,
 double epsilon,
 double startingV,
 GroupConstitution groupState,
 Broadcast broadcast,
 Long timeout,
 TimeUnit unit,
 Double defaultValue,
 ApproximateConsensusHandler<ConsensusAttachment> handler,
 ConsensusAttachment attachment)

ConsensusInstanceSkeleton

public ConsensusInstanceSkeleton(T snapshot,
 RequestID reqID,
 InstanceID instanceID,
 Double startingV,
 Long timeout,
 TimeUnit unit,
 Double defaultValue,
 ApproximateConsensusHandler<ConsensusAttachment> handler,
 ConsensusAttachment attachment,
 MessageLogger logger)

Method Details

approximateConsensus_other

public CompletableFuture<Double> approximateConsensus_other(ApproximationMessage msg)

Description copied from interface: ConsensusInstance

Method called when a new approximate consensus instance is started by another process.

Specified by:

approximateConsensus_other in interface ConsensusInstance<ConsensusAttachment>

Parameters:

msg - The first message to be processed.

Returns:

Completable Future containing the result of this instance of consensus

approximateConsensus_self

public CompletableFuture<Double> approximateConsensus_self()

Description copied from interface: ConsensusInstance

Method called when new approximate consensus instance is started by the calling process.

Specified by:

approximateConsensus_self in interface ConsensusInstance<ConsensusAttachment>

Returns:

Completable Future containing the result of this instance of consensus

exchange

public void exchange(Byte msgType,
 ApproximationMessage msg,
 AddressInterface q)

Description copied from interface: ConsensusInstance

Method called as handler of an approximation message. Consumes the message, which may advance the state of the consensus instance.

Specified by:

exchange in interface ConsensusInstance<ConsensusAttachment>

Parameters:

msgType - Type of message (initialization, approximation, etc.)

msg - Object containing the payload of the message

q - Address of the message's sender

consensusStillPossible

public boolean consensusStillPossible()

Description copied from interface: ConsensusInstance

Check if necessary conditions to guarantee correctness in the execution of the algorithm are still met.

Specified by:

consensusStillPossible in interface ConsensusInstance<ConsensusAttachment>

Returns:

True if conditions are met, false, otherwise.

getGroupState

public Map<? extends AddressInterface,? extends ProcessInterface> getGroupState()

Description copied from interface: ConsensusInstance

Getter for the consensus instance's snapshot of the group's constitution

Specified by:

getGroupState in interface ConsensusInstance<ConsensusAttachment>

Returns:

Group Constitution as a mapping of group members to their respective address.

getReqID

public RequestID getReqID()

Description copied from interface: ConsensusInstance

Getter for the unique identifier of this consensus instance.

Specified by:

getReqID in interface ConsensusInstance<ConsensusAttachment>

Returns:

Unique identifier of the consensus instance.

getMetrics

public ConsensusMetrics getMetrics()

Description copied from interface: ConsensusInstance

Get the object containing several relevant metrics to profile the execution of this instance of consensus

Specified by:

getMetrics in interface ConsensusInstance<ConsensusAttachment>

Returns:

Object storing metrics relative to an execution of an approximate consensus algorithm.