LWWRegister

org.apache.pekko.cluster.ddata.LWWRegister
See theLWWRegister companion object

Implements a 'Last Writer Wins Register' CRDT, also called a 'LWW-Register'.

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

Merge takes the register with highest timestamp. Note that this relies on synchronized clocks. LWWRegister should only be used when the choice of value is not important for concurrent updates occurring within the clock skew.

Merge takes the register updated by the node with lowest address (UniqueAddress is ordered) if the timestamps are exactly the same.

Instead of using timestamps based on System.currentTimeMillis() time it is possible to use a timestamp value based on something else, for example an increasing version number from a database record that is used for optimistic concurrency control.

The defaultClock is using max value of System.currentTimeMillis() and currentTimestamp + 1. This means that the timestamp is increased for changes on the same node that occurs within the same millisecond. It also means that it is safe to use the LWWRegister without synchronized clocks when there is only one active writer, e.g. a Cluster Singleton. Such a single writer should then first read current value with ReadMajority (or more) before changing and writing the value with WriteMajority (or more).

For first-write-wins semantics you can use the LWWRegister#reverseClock instead of the LWWRegister#defaultClock

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

Attributes

Companion
object
Source
LWWRegister.scala
Graph
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

type T = LWWRegister[A]

The type of the concrete implementation, e.g. GSet[A]. To be specified by subclass.

The type of the concrete implementation, e.g. GSet[A]. To be specified by subclass.

Attributes

Source
LWWRegister.scala

Value members

Concrete methods

override def equals(o: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
Source
LWWRegister.scala
def getValue(): A

Java API

Java API

Attributes

Source
LWWRegister.scala
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
Source
LWWRegister.scala
override def merge(that: LWWRegister[A]): LWWRegister[A]

Monotonic merge function.

Monotonic merge function.

Attributes

Definition Classes
Source
LWWRegister.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
LWWRegister.scala

The current value was set by this node.

The current value was set by this node.

Attributes

Source
LWWRegister.scala
def withValue(node: SelfUniqueAddress, value: A, clock: Clock[A]): LWWRegister[A]

Change the value of the register.

Change the value of the register.

You can provide your clock implementation instead of using timestamps based on System.currentTimeMillis() time. The timestamp can for example be an increasing version number from a database record that is used for optimistic concurrency control.

Attributes

Source
LWWRegister.scala
def withValue(node: SelfUniqueAddress, value: A): LWWRegister[A]

Change the value of the register.

Change the value of the register.

Attributes

Source
LWWRegister.scala
def withValueOf(value: A)(implicit node: SelfUniqueAddress, clock: Clock[A]): LWWRegister[A]

Change the value of the register.

Change the value of the register.

You can provide your clock implementation instead of using timestamps based on System.currentTimeMillis() time. The timestamp can for example be an increasing version number from a database record that is used for optimistic concurrency control.

Attributes

Source
LWWRegister.scala

Deprecated methods

def withValue(value: A)(implicit node: Cluster, clock: Clock[A]): LWWRegister[A]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
LWWRegister.scala
def withValue(node: Cluster, value: A): LWWRegister[A]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
LWWRegister.scala
def withValue(node: Cluster, value: A, clock: Clock[A]): LWWRegister[A]

Attributes

Deprecated
[Since version Akka 2.5.20]
Source
LWWRegister.scala

Concrete fields

Attributes

Source
LWWRegister.scala
val value: A

Attributes

Source
LWWRegister.scala