final class GCounter extends ReplicatedData with ReplicatedDataSerialization with RemovedNodePruning with FastMerge

Implements a 'Growing Counter' CRDT, also called a 'G-Counter'.

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

A G-Counter is a increment-only counter (inspired by vector clocks) in which only increment and merge are possible. Incrementing the counter adds 1 to the count for the current node. Divergent histories are resolved by taking the maximum count for each node (like a vector clock merge). The value of the counter is the sum of all node counts.

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

Annotations
@SerialVersionUID()
Source
GCounter.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GCounter
  2. FastMerge
  3. RemovedNodePruning
  4. ReplicatedDataSerialization
  5. Serializable
  6. Serializable
  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. All

Type Members

  1. type T = GCounter

    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
    GCounterReplicatedData

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): GCounter

    Increment the counter with the delta specified.

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

  4. def ->[B](y: B): (GCounter, B)
    Implicit
    This member is added by an implicit conversion from GCounter to ArrowAssoc[GCounter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (GCounter) ⇒ Boolean, msg: ⇒ Any): GCounter
    Implicit
    This member is added by an implicit conversion from GCounter to Ensuring[GCounter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (GCounter) ⇒ Boolean): GCounter
    Implicit
    This member is added by an implicit conversion from GCounter to Ensuring[GCounter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): GCounter
    Implicit
    This member is added by an implicit conversion from GCounter to Ensuring[GCounter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): GCounter
    Implicit
    This member is added by an implicit conversion from GCounter to Ensuring[GCounter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(o: Any): Boolean
    Definition Classes
    GCounter → AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GCounter to StringFormat[GCounter] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. def getValue: BigInteger

    Java API: Current total value of the counter.

  18. def hashCode(): Int
    Definition Classes
    GCounter → AnyRef → Any
  19. def increment(node: Cluster, delta: Long = 1): GCounter

    Increment the counter with the delta specified.

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

  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def merge(that: GCounter): GCounter

    Monotonic merge function.

    Monotonic merge function.

    Definition Classes
    GCounterReplicatedData
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. 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
    GCounterRemovedNodePruning
  24. final def notify(): Unit
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  26. def prune(removedNode: UniqueAddress, collapseInto: UniqueAddress): GCounter

    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
    GCounterRemovedNodePruning
  27. def pruningCleanup(removedNode: UniqueAddress): GCounter

    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
    GCounterRemovedNodePruning
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    GCounter → AnyRef → Any
  30. def value: BigInt

    Scala API: Current total value of the counter.

  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def [B](y: B): (GCounter, B)
    Implicit
    This member is added by an implicit conversion from GCounter to ArrowAssoc[GCounter] 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 GCounter to any2stringadd[GCounter] 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:
    (gCounter: any2stringadd[GCounter]).+(other)
    Definition Classes
    any2stringadd

Inherited from FastMerge

Inherited from RemovedNodePruning

Inherited from Serializable

Inherited from Serializable

Inherited from ReplicatedData

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped