sealed abstract class VersionVector extends ReplicatedData with ReplicatedDataSerialization with RemovedNodePruning

Representation of a Vector-based clock (counting clock), inspired by Lamport logical clocks.

Reference:
   1) Leslie Lamport (1978). "Time, clocks, and the ordering of events in a distributed system". Communications of the ACM 21 (7): 558-565.
   2) Friedemann Mattern (1988). "Virtual Time and Global States of Distributed Systems". Workshop on Parallel and Distributed Algorithms: pp. 215-226

Based on code from akka.cluster.VectorClock.

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

Annotations
@SerialVersionUID()
Source
VersionVector.scala
Linear Supertypes
RemovedNodePruning, ReplicatedDataSerialization, Serializable, ReplicatedData, AnyRef, Any
Known Subclasses
ManyVersionVector, OneVersionVector
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VersionVector
  2. RemovedNodePruning
  3. ReplicatedDataSerialization
  4. Serializable
  5. ReplicatedData
  6. AnyRef
  7. 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 T = VersionVector

    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
    VersionVector → ReplicatedData

Abstract Value Members

  1. abstract def isEmpty: Boolean
  2. abstract def merge(that: VersionVector): VersionVector

    Merges this VersionVector with another VersionVector.

    Merges this VersionVector with another VersionVector. E.g. merges its versioned history.

    Definition Classes
    VersionVector → ReplicatedData
  3. abstract 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
    RemovedNodePruning
  4. abstract 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
    VersionVector → RemovedNodePruning
  5. abstract def prune(removedNode: UniqueAddress, collapseInto: UniqueAddress): VersionVector

    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
    VersionVector → RemovedNodePruning
  6. abstract def pruningCleanup(removedNode: UniqueAddress): VersionVector

    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
    VersionVector → RemovedNodePruning

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from VersionVector toany2stringadd[VersionVector] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (VersionVector, B)
    Implicit
    This member is added by an implicit conversion from VersionVector toArrowAssoc[VersionVector] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. def :+(node: SelfUniqueAddress): VersionVector

    Increment the version for the node passed as argument.

    Increment the version for the node passed as argument. Returns a new VersionVector.

  6. def <(that: VersionVector): Boolean

    Returns true if this is before that else false.

  7. def <>(that: VersionVector): Boolean

    Returns true if this and that are concurrent else false.

  8. def ==(that: VersionVector): Boolean

    Returns true if this VersionVector has the same history as the 'that' VersionVector else false.

  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def >(that: VersionVector): Boolean

    Returns true if this is after that else false.

  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  13. def compareTo(that: VersionVector): Ordering

    Compare two version vectors.

    Compare two version vectors. The outcome will be one of the following:

    1. Version 1 is SAME (==)       as Version 2 iff for all i c1(i) == c2(i)
2. Version 1 is BEFORE (<)      Version 2 iff for all i c1(i) <= c2(i) and there exist a j such that c1(j) < c2(j)
3. Version 1 is AFTER (>)       Version 2 iff for all i c1(i) >= c2(i) and there exist a j such that c1(j) > c2(j).
4. Version 1 is CONCURRENT (<>) to Version 2 otherwise.
  14. def ensuring(cond: (VersionVector) => Boolean, msg: => Any): VersionVector
    Implicit
    This member is added by an implicit conversion from VersionVector toEnsuring[VersionVector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (VersionVector) => Boolean): VersionVector
    Implicit
    This member is added by an implicit conversion from VersionVector toEnsuring[VersionVector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): VersionVector
    Implicit
    This member is added by an implicit conversion from VersionVector toEnsuring[VersionVector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): VersionVector
    Implicit
    This member is added by an implicit conversion from VersionVector toEnsuring[VersionVector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. def increment(node: SelfUniqueAddress): VersionVector

    Increment the version for the node passed as argument.

    Increment the version for the node passed as argument. Returns a new VersionVector.

  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from VersionVector toStringFormat[VersionVector] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (VersionVector, B)
    Implicit
    This member is added by an implicit conversion from VersionVector toArrowAssoc[VersionVector] 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.

Inherited from RemovedNodePruning

Inherited from ReplicatedDataSerialization

Inherited from Serializable

Inherited from ReplicatedData

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromVersionVector to any2stringadd[VersionVector]

Inherited by implicit conversion StringFormat fromVersionVector to StringFormat[VersionVector]

Inherited by implicit conversion Ensuring fromVersionVector to Ensuring[VersionVector]

Inherited by implicit conversion ArrowAssoc fromVersionVector to ArrowAssoc[VersionVector]

Ungrouped