final class PNCounter extends ReplicatedData 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. ReplicatedData
  7. AnyRef
  8. 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 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 +(delta: Long)(implicit node: Cluster): PNCounter

    Increment the counter with the delta specified.

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

  4. def -(delta: Long)(implicit node: Cluster): PNCounter

    Decrement the counter with the delta specified.

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

  5. 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()
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def decrement(node: Cluster, delta: Long = 1): PNCounter

    Decrement the counter with the delta specified.

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

  10. 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
  11. 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
  12. 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
  13. 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
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(o: Any): Boolean
    Definition Classes
    PNCounter → AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. 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()
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  19. def getValue: BigInteger

    Java API: Current total value of the counter.

  20. def hashCode(): Int
    Definition Classes
    PNCounter → AnyRef → Any
  21. def increment(node: Cluster, delta: Long = 1): PNCounter

    Increment the counter with the delta specified.

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

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

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    PNCounterReplicatedData
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. 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
  26. final def notify(): Unit
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  28. 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
  29. 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
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    PNCounter → AnyRef → Any
  32. def value: BigInt

    Scala API: Current total value of the counter.

  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. 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

Inherited from RemovedNodePruning

Inherited from Serializable

Inherited from Serializable

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