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
- Alphabetic
- By Inheritance
- PNCounter
- RemovedNodePruning
- ReplicatedDataSerialization
- Serializable
- ReplicatedDelta
- DeltaReplicatedData
- ReplicatedData
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- 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
Tor a different type if needed. For exampleGSetuses the same type andORSetuses different types.- Definition Classes
- PNCounter → DeltaReplicatedData
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (PNCounter, B)
- def :+(n: BigInt)(implicit node: SelfUniqueAddress): PNCounter
Increment the counter with the delta
nspecified.Increment the counter with the delta
nspecified. If the delta is negative then it will decrement instead of increment. - def :+(n: Long)(implicit node: SelfUniqueAddress): PNCounter
Increment the counter with the delta
nspecified.Increment the counter with the delta
nspecified. If the delta is negative then it will decrement instead of increment. - final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def decrement(node: SelfUniqueAddress, n: BigInteger): PNCounter
Java API: Decrement the counter with the delta
nspecified.Java API: Decrement the counter with the delta
nspecified. If the deltanis negative then it will increment instead of decrement. - def decrement(node: SelfUniqueAddress, n: BigInt): PNCounter
Scala API: Decrement the counter with the delta
nspecified.Scala API: Decrement the counter with the delta
nspecified. If the deltanis negative then it will increment instead of decrement. - def decrement(node: SelfUniqueAddress, n: Long): PNCounter
Decrement the counter with the delta
nspecified.Decrement the counter with the delta
nspecified. If the deltanis negative then it will increment instead of decrement. - def decrement(n: BigInt)(implicit node: SelfUniqueAddress): PNCounter
Decrement the counter with the delta
nspecified.Decrement the counter with the delta
nspecified. If the delta is negative then it will increment instead of decrement. - def decrement(n: Long)(implicit node: SelfUniqueAddress): PNCounter
Decrement the counter with the delta
nspecified.Decrement the counter with the delta
nspecified. If the delta is negative then it will increment instead of decrement. - def delta: Option[PNCounter]
The accumulated delta of mutator operations since previous #resetDelta.
The accumulated delta of mutator operations since previous #resetDelta. When the
Replicatorinvokes themodifyfunction of theUpdatemessage 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 theReplicatorwith the #delta accessor. Themodifyfunction shall still return the full state in the same way asReplicatedDatawithout support for deltas.- Definition Classes
- PNCounter → DeltaReplicatedData
- def ensuring(cond: (PNCounter) => Boolean, msg: => Any): PNCounter
- def ensuring(cond: (PNCounter) => Boolean): PNCounter
- def ensuring(cond: Boolean, msg: => Any): PNCounter
- def ensuring(cond: Boolean): PNCounter
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(o: Any): Boolean
- Definition Classes
- PNCounter → AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getValue: BigInteger
Java API: Current total value of the counter.
- def hashCode(): Int
- Definition Classes
- PNCounter → AnyRef → Any
- def increment(node: SelfUniqueAddress, n: Long): PNCounter
Java API: Increment the counter with the delta
nspecified.Java API: Increment the counter with the delta
nspecified. If the delta is negative then it will decrement instead of increment. - def increment(node: SelfUniqueAddress, n: BigInteger): PNCounter
Java API: Increment the counter with the delta
nspecified.Java API: Increment the counter with the delta
nspecified. If the delta is negative then it will decrement instead of increment. - def increment(n: BigInt)(implicit node: SelfUniqueAddress): PNCounter
Increment the counter with the delta
nspecified.Increment the counter with the delta
nspecified. If the delta is negative then it will decrement instead of increment. - def increment(n: Long)(implicit node: SelfUniqueAddress): PNCounter
Scala API: Increment the counter with the delta
nspecified.Scala API: Increment the counter with the delta
nspecified. If the delta is negative then it will decrement instead of increment. - final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def merge(that: PNCounter): PNCounter
Monotonic merge function.
Monotonic merge function.
- Definition Classes
- PNCounter → ReplicatedData
- 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
Dof the delta is of the same type as the full stateTthis method can be implemented by delegating tomerge.- Definition Classes
- PNCounter → DeltaReplicatedData
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def prune(removedNode: UniqueAddress, collapseInto: UniqueAddress): PNCounter
When the
removednode 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
removednode 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
- 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
- def resetDelta: PNCounter
Reset collection of deltas from mutator operations.
Reset collection of deltas from mutator operations. When the
Replicatorinvokes themodifyfunction of theUpdatemessage 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 theReplicatorwith the #delta accessor. When theReplicatorhas grabbed thedeltait will invoke this method to get a clean data instance without the delta.- Definition Classes
- PNCounter → DeltaReplicatedData
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- PNCounter → AnyRef → Any
- def value: BigInt
Scala API: Current total value of the counter.
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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
zeroto create the initial full state.- Definition Classes
- PNCounter → ReplicatedDelta
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from PNCounter toStringFormat[PNCounter] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (PNCounter, B)
- Implicit
- This member is added by an implicit conversion from PNCounter toArrowAssoc[PNCounter] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.