Package org.apache.pekko.cluster.ddata

Class ORSet<A>

java.lang.Object
org.apache.pekko.cluster.ddata.ORSet<A>
All Implemented Interfaces:
Serializable, DeltaReplicatedData, FastMerge, RemovedNodePruning, ReplicatedData, ReplicatedDataSerialization
public final class ORSet<A> extends Object implements DeltaReplicatedData, ReplicatedDataSerialization, RemovedNodePruning, FastMerge
See Also:

  • Method Details

    • empty

      public static <A> ORSet<A> empty()

    • apply

      public static ORSet<Object> apply()

    • create

      public static <A> ORSet<A> create()
      Java API

    • unapply

      public static <A> scala.Option<scala.collection.immutable.Set<A>> unapply(ORSet<A> s)
      Extract the elements().

    • unapply

      public static scala.Option<scala.collection.immutable.Set<Object>> unapply(ReplicatedData a)
      Extract the elements() of an ORSet.

    • delta

      public scala.Option<ORSet.DeltaOp> delta()
      Description copied from interface: DeltaReplicatedData
      The accumulated delta of mutator operations since previous DeltaReplicatedData.resetDelta(). When the Replicator invokes the modify function of the Update message 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 the Replicator with the DeltaReplicatedData.delta() accessor. The modify function shall still return the full state in the same way as ReplicatedData without support for deltas.
      Specified by:
      delta in interface DeltaReplicatedData

    • elements

      public scala.collection.immutable.Set<A> elements()
      Scala API

    • getElements

      public Set<A> getElements()
      Java API

    • contains

      public boolean contains(A a)

    • isEmpty

      public boolean isEmpty()

    • size

      public int size()

    • $colon$plus

      public ORSet<A> $colon$plus(A element, SelfUniqueAddress node)
      Adds an element to the set.

    • add

      public ORSet<A> add(SelfUniqueAddress node, A element)
      Adds an element to the set.

    • remove

      public ORSet<A> remove(A element, SelfUniqueAddress node)
      Scala API Removes an element from the set.

    • remove

      public ORSet<A> remove(SelfUniqueAddress node, A element)
      Java API Removes an element from the set.

    • clear

      public ORSet<A> clear(SelfUniqueAddress node)
      Removes all elements from the set, but keeps the history. This has the same result as using {@link ORSet#remove(node:org\.apache\.pekko\.cluster\.ddata\.SelfUniqueAddress*} for each element, but it is more efficient.

    • merge

      public ORSet<A> merge(ORSet<A> that)
      When element is in this Set but not in that Set: Compare the "birth dot" of the present element to the version vector in the Set it is absent from. If the element dot is not "seen" by other Set version vector, that means the other set has yet to see this add, and the element is to be in the merged Set. If the other Set version vector dominates the dot, that means the other Set has removed the element already, and the element is not to be in the merged Set.

      When element in both this Set and in that Set: Some dots may still need to be shed. If this Set has dots that the other Set does not have, and the other Set version vector dominates those dots, then we need to drop those dots. Keep only common dots, and dots that are not dominated by the other sides version vector

    • mergeDelta

      public ORSet<A> mergeDelta(ORSet.DeltaOp thatDelta)

    • resetDelta

      public ORSet<A> resetDelta()
      Description copied from interface: DeltaReplicatedData
      Reset collection of deltas from mutator operations. When the Replicator invokes the modify function of the Update message 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 the Replicator with the DeltaReplicatedData.delta() accessor. When the Replicator has grabbed the delta it will invoke this method to get a clean data instance without the delta.
      Specified by:
      resetDelta in interface DeltaReplicatedData

    • modifiedByNodes

      public scala.collection.immutable.Set<UniqueAddress> modifiedByNodes()
      Description copied from interface: RemovedNodePruning
      The nodes that have changed the state for this data and would need pruning when such node is no longer part of the cluster.
      Specified by:
      modifiedByNodes in interface RemovedNodePruning

    • needPruningFrom

      public boolean needPruningFrom(UniqueAddress removedNode)
      Description copied from interface: RemovedNodePruning
      Does it have any state changes from a specific node, which has been removed from the cluster.
      Specified by:
      needPruningFrom in interface RemovedNodePruning

    • prune

      public ORSet<A> prune(UniqueAddress removedNode, UniqueAddress collapseInto)
      Description copied from interface: RemovedNodePruning
      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.
      Specified by:
      prune in interface RemovedNodePruning

    • pruningCleanup

      public ORSet<A> pruningCleanup(UniqueAddress removedNode)
      Description copied from interface: RemovedNodePruning
      Remove data entries from a node that has been removed from the cluster and already been pruned.
      Specified by:
      pruningCleanup in interface RemovedNodePruning

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object