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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PNCounter
  2. RemovedNodePruning
  3. ReplicatedDataSerialization
  4. Serializable
  5. Serializable
  6. ReplicatedDelta
  7. DeltaReplicatedData
  8. ReplicatedData
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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
    PNCounterDeltaReplicatedData
  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
    PNCounterReplicatedData

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(n: BigInt)(implicit node: Cluster): 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.

  4. def +(n: Long)(implicit node: Cluster): 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.

  5. def -(n: BigInt)(implicit node: Cluster): 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.

  6. def -(n: Long)(implicit node: Cluster): 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 ->[B](y: B): (PNCounter, B)
    Implicit
    This member is added by an implicit conversion from PNCounter to ArrowAssoc[PNCounter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  11. def decrement(node: Cluster, 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.

  12. def decrement(node: Cluster, 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.

  13. def decrement(node: Cluster, n: Long = 1): 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.

  14. 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
    PNCounterDeltaReplicatedData
  15. def ensuring(cond: (PNCounter) ⇒ Boolean, msg: ⇒ Any): PNCounter
    Implicit
    This member is added by an implicit conversion from PNCounter to Ensuring[PNCounter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (PNCounter) ⇒ Boolean): PNCounter
    Implicit
    This member is added by an implicit conversion from PNCounter to Ensuring[PNCounter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): PNCounter
    Implicit
    This member is added by an implicit conversion from PNCounter to Ensuring[PNCounter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): PNCounter
    Implicit
    This member is added by an implicit conversion from PNCounter to Ensuring[PNCounter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(o: Any): Boolean
    Definition Classes
    PNCounter → AnyRef → Any
  21. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from PNCounter to StringFormat[PNCounter] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def getValue: BigInteger

    Java API: Current total value of the counter.

  24. def hashCode(): Int
    Definition Classes
    PNCounter → AnyRef → Any
  25. def increment(node: Cluster, 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.

  26. def increment(node: Cluster, n: BigInt): 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.

  27. def increment(node: Cluster, n: Long = 1): 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.

  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def merge(that: PNCounter): PNCounter

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    PNCounterReplicatedData
  30. 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
    PNCounterDeltaReplicatedData
  31. 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
    PNCounterRemovedNodePruning
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. 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
    PNCounterRemovedNodePruning
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. 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
    PNCounterRemovedNodePruning
  37. 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
    PNCounterRemovedNodePruning
  38. 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
    PNCounterDeltaReplicatedData
  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    PNCounter → AnyRef → Any
  41. def value: BigInt

    Scala API: Current total value of the counter.

  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. 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
    PNCounterReplicatedDelta
  46. def [B](y: B): (PNCounter, B)
    Implicit
    This member is added by an implicit conversion from PNCounter to ArrowAssoc[PNCounter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from PNCounter to any2stringadd[PNCounter] performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (pNCounter: any2stringadd[PNCounter]).+(other)
    Definition Classes
    any2stringadd

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from RemovedNodePruning

Inherited from Serializable

Inherited from Serializable

Inherited from ReplicatedDelta

Inherited from DeltaReplicatedData

Inherited from ReplicatedData

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from PNCounter to any2stringadd[PNCounter]

Inherited by implicit conversion StringFormat from PNCounter to StringFormat[PNCounter]

Inherited by implicit conversion Ensuring from PNCounter to Ensuring[PNCounter]

Inherited by implicit conversion ArrowAssoc from PNCounter to ArrowAssoc[PNCounter]

Ungrouped