Package akka.cluster.ddata

Class GCounter

java.lang.Object

akka.cluster.ddata.GCounter

All Implemented Interfaces:

DeltaReplicatedData, FastMerge, RemovedNodePruning, ReplicatedData, ReplicatedDataSerialization, ReplicatedDelta, java.io.Serializable

public final class GCounter
extends java.lang.Object
implements DeltaReplicatedData, ReplicatedDelta, ReplicatedDataSerialization, RemovedNodePruning, FastMerge

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
GCounter	$colon$plus(long n, SelfUniqueAddress node)	Increment the counter with the delta n specified.
static GCounter	apply()
static GCounter	create()	Java API
scala.Option<GCounter>	delta()	The accumulated delta of mutator operations since previous DeltaReplicatedData.resetDelta().
static GCounter	empty()
boolean	equals(java.lang.Object o)
java.math.BigInteger	getValue()	Java API: Current total value of the counter.
int	hashCode()
GCounter	increment(SelfUniqueAddress node, long n)	Increment the counter with the delta n specified.
GCounter	merge(GCounter that)
GCounter	mergeDelta(GCounter thatDelta)
scala.collection.immutable.Set<UniqueAddress>	modifiedByNodes()	The nodes that have changed the state for this data and would need pruning when such node is no longer part of the cluster.
boolean	needPruningFrom(UniqueAddress removedNode)	Does it have any state changes from a specific node, which has been removed from the cluster.
GCounter	prune(UniqueAddress removedNode, UniqueAddress collapseInto)	When the removed node has been removed from the cluster the state changes from that node will be pruned by collapsing the data entries to another node.
GCounter	pruningCleanup(UniqueAddress removedNode)	Remove data entries from a node that has been removed from the cluster and already been pruned.
GCounter	resetDelta()	Reset collection of deltas from mutator operations.
java.lang.String	toString()
static scala.Option<scala.math.BigInt>	unapply(GCounter c)	Extract the value().
scala.math.BigInt	value()	Scala API: Current total value of the counter.
GCounter	zero()	The empty full state.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface akka.cluster.ddata.DeltaReplicatedData

mergeDelta

Methods inherited from interface akka.cluster.ddata.FastMerge

ancestor_$eq, assignAncestor, clearAncestor, isAncestorOf

Methods inherited from interface akka.cluster.ddata.ReplicatedData

merge

Method Detail

empty

public static GCounter empty()

apply

public static GCounter apply()

create

public static GCounter create()

Java API

unapply

public static scala.Option<scala.math.BigInt> unapply(GCounter c)

Extract the value().

delta

public scala.Option<GCounter> delta()

Description copied from interface: DeltaReplicatedData

The accumulated delta of mutator operations since previous DeltaReplicatedData.resetDelta(). When the Replicator invokes the modify function of the Update message and the user code is invoking one or more mutator operations the data is collecting the delta of the operations and makes it available for the Replicator with the DeltaReplicatedData.delta() accessor. The modify function shall still return the full state in the same way as ReplicatedData without support for deltas.

Specified by:

delta in interface DeltaReplicatedData

value

public scala.math.BigInt value()

Scala API: Current total value of the counter.

getValue

public java.math.BigInteger getValue()

Java API: Current total value of the counter.

$colon$plus

public GCounter $colon$plus(long n,
                            SelfUniqueAddress node)

Increment the counter with the delta n specified. The delta must be zero or positive.

increment

public GCounter increment(SelfUniqueAddress node,
                          long n)

Increment the counter with the delta n specified. The delta n must be zero or positive.

merge

public GCounter merge(GCounter that)

mergeDelta

public GCounter mergeDelta(GCounter thatDelta)

zero

public GCounter zero()

Description copied from interface: ReplicatedDelta

The empty full state. This is used when a delta is received and no existing full state exists on the receiving side. Then the delta is merged into the zero to create the initial full state.

Specified by:

zero in interface ReplicatedDelta

resetDelta

public GCounter resetDelta()

Description copied from interface: DeltaReplicatedData

Reset collection of deltas from mutator operations. When the Replicator invokes the modify function of the Update message the delta is always "reset" and when the user code is invoking one or more mutator operations the data is collecting the delta of the operations and makes it available for the Replicator with the DeltaReplicatedData.delta() accessor. When the Replicator has grabbed the delta it will invoke this method to get a clean data instance without the delta.

Specified by:

resetDelta in interface DeltaReplicatedData

modifiedByNodes

public scala.collection.immutable.Set<UniqueAddress> modifiedByNodes()

Description copied from interface: RemovedNodePruning

The nodes that have changed the state for this data and would need pruning when such node is no longer part of the cluster.

Specified by:

modifiedByNodes in interface RemovedNodePruning

needPruningFrom

public boolean needPruningFrom(UniqueAddress removedNode)

Description copied from interface: RemovedNodePruning

Does it have any state changes from a specific node, which has been removed from the cluster.

Specified by:

needPruningFrom in interface RemovedNodePruning

prune

public GCounter prune(UniqueAddress removedNode,
                      UniqueAddress collapseInto)

Description copied from interface: RemovedNodePruning

When the removed node has been removed from the cluster the state changes from that node will be pruned by collapsing the data entries to another node.

Specified by:

prune in interface RemovedNodePruning

pruningCleanup

public GCounter pruningCleanup(UniqueAddress removedNode)

Description copied from interface: RemovedNodePruning

Remove data entries from a node that has been removed from the cluster and already been pruned.

Specified by:

pruningCleanup in interface RemovedNodePruning

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object