final class PNCounter extends DeltaReplicatedData with ReplicatedDelta with ReplicatedDataSerialization with RemovedNodePruning

Implements a 'Increment/Decrement Counter' CRDT, also called a 'PN-Counter'.

It is described in the paper A comprehensive study of Convergent and Commutative Replicated Data Types.

PN-Counters allow the counter to be incremented by tracking the increments (P) separate from the decrements (N). Both P and N are represented as two internal GCounters. Merge is handled by merging the internal P and N counters. The value of the counter is the value of the P counter minus the value of the N counter.

This class is immutable, i.e. "modifying" methods return a new instance.

Annotations
@SerialVersionUID()
Source
PNCounter.scala
Linear Supertypes
RemovedNodePruning, ReplicatedDataSerialization, Serializable, ReplicatedDelta, DeltaReplicatedData, ReplicatedData, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PNCounter
  2. RemovedNodePruning
  3. ReplicatedDataSerialization
  4. Serializable
  5. ReplicatedDelta
  6. DeltaReplicatedData
  7. ReplicatedData
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type D = PNCounter

    The type of the delta.

    The type of the delta. To be specified by subclass. It may be the same type as T or a different type if needed. For example GSet uses the same type and ORSet uses different types.

    Definition Classes
    PNCounter → DeltaReplicatedData
  2. type T = PNCounter

    The type of the concrete implementation, e.g.

    The type of the concrete implementation, e.g. GSet[A]. To be specified by subclass.

    Definition Classes
    PNCounter → ReplicatedData

Value Members

  1. def :+(n: BigInt)(implicit node: SelfUniqueAddress): PNCounter

    Increment the counter with the delta n specified.

    Increment the counter with the delta n specified. If the delta is negative then it will decrement instead of increment.

  2. def :+(n: Long)(implicit node: SelfUniqueAddress): PNCounter

    Increment the counter with the delta n specified.

    Increment the counter with the delta n specified. If the delta is negative then it will decrement instead of increment.

  3. def decrement(node: SelfUniqueAddress, n: BigInteger): PNCounter

    Java API: Decrement the counter with the delta n specified.

    Java API: Decrement the counter with the delta n specified. If the delta n is negative then it will increment instead of decrement.

  4. def decrement(node: SelfUniqueAddress, n: BigInt): PNCounter

    Scala API: Decrement the counter with the delta n specified.

    Scala API: Decrement the counter with the delta n specified. If the delta n is negative then it will increment instead of decrement.

  5. def decrement(node: SelfUniqueAddress, n: Long): PNCounter

    Decrement the counter with the delta n specified.

    Decrement the counter with the delta n specified. If the delta n is negative then it will increment instead of decrement.

  6. def decrement(n: BigInt)(implicit node: SelfUniqueAddress): PNCounter

    Decrement the counter with the delta n specified.

    Decrement the counter with the delta n specified. If the delta is negative then it will increment instead of decrement.

  7. def decrement(n: Long)(implicit node: SelfUniqueAddress): PNCounter

    Decrement the counter with the delta n specified.

    Decrement the counter with the delta n specified. If the delta is negative then it will increment instead of decrement.

  8. def delta: Option[PNCounter]

    The accumulated delta of mutator operations since previous #resetDelta.

    The accumulated delta of mutator operations since previous #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 #delta accessor. The modify function shall still return the full state in the same way as ReplicatedData without support for deltas.

    Definition Classes
    PNCounter → DeltaReplicatedData
  9. def equals(o: Any): Boolean
    Definition Classes
    PNCounter → AnyRef → Any
  10. def getValue: BigInteger

    Java API: Current total value of the counter.

  11. def hashCode(): Int
    Definition Classes
    PNCounter → AnyRef → Any
  12. def increment(node: SelfUniqueAddress, n: Long): PNCounter

    Java API: Increment the counter with the delta n specified.

    Java API: Increment the counter with the delta n specified. If the delta is negative then it will decrement instead of increment.

  13. def increment(node: SelfUniqueAddress, n: BigInteger): PNCounter

    Java API: Increment the counter with the delta n specified.

    Java API: Increment the counter with the delta n specified. If the delta is negative then it will decrement instead of increment.

  14. def increment(n: BigInt)(implicit node: SelfUniqueAddress): PNCounter

    Increment the counter with the delta n specified.

    Increment the counter with the delta n specified. If the delta is negative then it will decrement instead of increment.

  15. def increment(n: Long)(implicit node: SelfUniqueAddress): PNCounter

    Scala API: Increment the counter with the delta n specified.

    Scala API: Increment the counter with the delta n specified. If the delta is negative then it will decrement instead of increment.

  16. def merge(that: PNCounter): PNCounter

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    PNCounter → ReplicatedData
  17. def mergeDelta(thatDelta: PNCounter): PNCounter

    When delta is merged into the full state this method is used.

    When delta is merged into the full state this method is used. When the type D of the delta is of the same type as the full state T this method can be implemented by delegating to merge.

    Definition Classes
    PNCounter → DeltaReplicatedData
  18. def modifiedByNodes: Set[UniqueAddress]

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

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

    Definition Classes
    PNCounter → RemovedNodePruning
  19. def needPruningFrom(removedNode: UniqueAddress): Boolean

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

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

    Definition Classes
    PNCounter → RemovedNodePruning
  20. def prune(removedNode: UniqueAddress, collapseInto: UniqueAddress): PNCounter

    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.

    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.

    Definition Classes
    PNCounter → RemovedNodePruning
  21. def pruningCleanup(removedNode: UniqueAddress): PNCounter

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

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

    Definition Classes
    PNCounter → RemovedNodePruning
  22. def resetDelta: PNCounter

    Reset collection of deltas from mutator operations.

    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 #delta accessor. When the Replicator has grabbed the delta it will invoke this method to get a clean data instance without the delta.

    Definition Classes
    PNCounter → DeltaReplicatedData
  23. def toString(): String
    Definition Classes
    PNCounter → AnyRef → Any
  24. def value: BigInt

    Scala API: Current total value of the counter.

  25. def zero: PNCounter

    The empty full state.

    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.

    Definition Classes
    PNCounter → ReplicatedDelta