Class LWWDictionary<TKey, TValue>

Specialized LWWDictionary<TKey, TValue> with LWWRegister<T> values.

LWWRegister<T> relies on synchronized clocks and should only be used when the choice of value is not important for concurrent updates occurring within the clock skew. Instead of using timestamps based on DateTime.UtcNow.Ticks 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. For first-write-wins semantics you can use the ReverseClock instead of the DefaultClock

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

Inheritance

Object

LWWDictionary<TKey, TValue>

Implements

IDeltaReplicatedData<LWWDictionary<TKey, TValue>, ORDictionary.IDeltaOperation<>>

IDeltaReplicatedData

IRemovedNodePruning<LWWDictionary<TKey, TValue>>

IRemovedNodePruning

IReplicatedData<LWWDictionary<TKey, TValue>>

IReplicatedData

IReplicatedDataSerialization

IEquatable<LWWDictionary<TKey, TValue>>

IEnumerable<KeyValuePair<TKey, TValue>>

IEnumerable

Inherited Members

Object.Equals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: Akka.DistributedData

Assembly: Akka.DistributedData.dll

Syntax

[Serializable]
public sealed class LWWDictionary<TKey, TValue> : IDeltaReplicatedData<LWWDictionary<TKey, TValue>, ORDictionary<TKey, LWWRegister<TValue>>.IDeltaOperation>, IDeltaReplicatedData, IRemovedNodePruning<LWWDictionary<TKey, TValue>>, IRemovedNodePruning, IReplicatedData<LWWDictionary<TKey, TValue>>, IReplicatedData, IReplicatedDataSerialization, IEquatable<LWWDictionary<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable

Type Parameters

Name	Description
TKey	TBD
TValue	TBD

Constructors

| Improve this Doc View Source

LWWDictionary(ORDictionary<TKey, LWWRegister<TValue>>)

TBD

Declaration

public LWWDictionary(ORDictionary<TKey, LWWRegister<TValue>> underlying)

Parameters

Type	Name	Description
ORDictionary<TKey, LWWRegister<TValue>>	underlying	TBD

Fields

| Improve this Doc View Source

Empty

An empty instance of the LWWDictionary<TKey, TValue>

Declaration

public static readonly LWWDictionary<TKey, TValue> Empty

Field Value

Type	Description
LWWDictionary<TKey, TValue>

Properties

| Improve this Doc View Source

Count

Returns number of entries stored within current LWWDictionary<TKey, TValue>.

Declaration

public int Count { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

Delta

Declaration

public ORDictionary<TKey, LWWRegister<TValue>>.IDeltaOperation Delta { get; }

Property Value

Type	Description
ORDictionary.IDeltaOperation<>

| Improve this Doc View Source

Entries

Returns all entries stored within current LWWDictionary<TKey, TValue>

Declaration

public IImmutableDictionary<TKey, TValue> Entries { get; }

Property Value

Type	Description
System.Collections.Immutable.IImmutableDictionary<TKey, TValue>

| Improve this Doc View Source

IsEmpty

Determines if current LWWDictionary<TKey, TValue> is empty.

Declaration

public bool IsEmpty { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

Item[TKey]

Returns value stored under provided key.

Declaration

public TValue this[TKey key] { get; }

Parameters

Type	Name	Description
TKey	key	TBD

Property Value

Type	Description
TValue

| Improve this Doc View Source

Keys

Returns collection of keys stored within current LWWDictionary<TKey, TValue>.

Declaration

public IEnumerable<TKey> Keys { get; }

Property Value

Type	Description
IEnumerable<TKey>

| Improve this Doc View Source

KeyType

Declaration

public Type KeyType { get; }

Property Value

Type	Description
Type

| Improve this Doc View Source

ModifiedByNodes

Declaration

public ImmutableHashSet<UniqueAddress> ModifiedByNodes { get; }

Property Value

Type	Description
System.Collections.Immutable.ImmutableHashSet<UniqueAddress>

| Improve this Doc View Source

Values

Returns collection of values stored within current LWWDictionary<TKey, TValue>.

Declaration

public IEnumerable<TValue> Values { get; }

Property Value

Type	Description
IEnumerable<TValue>

| Improve this Doc View Source

ValueType

Declaration

public Type ValueType { get; }

Property Value

Type	Description
Type

Methods

| Improve this Doc View Source

ContainsKey(TKey)

Determines current LWWDictionary<TKey, TValue> contains entry with provided key.

Declaration

public bool ContainsKey(TKey key)

Parameters

Type	Name	Description
TKey	key	TBD

Returns

Type	Description
Boolean	TBD

| Improve this Doc View Source

Equals(LWWDictionary<TKey, TValue>)

TBD

Declaration

public bool Equals(LWWDictionary<TKey, TValue> other)

Parameters

Type	Name	Description
LWWDictionary<TKey, TValue>	other	TBD

Returns

Type	Description
Boolean	TBD

| Improve this Doc View Source

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

Object.Equals(Object)

| Improve this Doc View Source

GetEnumerator()

TBD

Declaration

public IEnumerator<KeyValuePair<TKey, TValue>> GetEnumerator()

Returns

Type	Description
IEnumerator<KeyValuePair<TKey, TValue>>	TBD

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

| Improve this Doc View Source

Merge(IReplicatedData)

TBD

Declaration

public IReplicatedData Merge(IReplicatedData other)

Parameters

Type	Name	Description
IReplicatedData	other	TBD

Returns

Type	Description
IReplicatedData	TBD

| Improve this Doc View Source

Merge(LWWDictionary<TKey, TValue>)

TBD

Declaration

public LWWDictionary<TKey, TValue> Merge(LWWDictionary<TKey, TValue> other)

Parameters

Type	Name	Description
LWWDictionary<TKey, TValue>	other	TBD

Returns

Type	Description
LWWDictionary<TKey, TValue>	TBD

| Improve this Doc View Source

MergeDelta(ORDictionary<TKey, LWWRegister<TValue>>.IDeltaOperation)

Declaration

public LWWDictionary<TKey, TValue> MergeDelta(ORDictionary<TKey, LWWRegister<TValue>>.IDeltaOperation delta)

Parameters

Type	Name	Description
ORDictionary.IDeltaOperation<>	delta

Returns

Type	Description
LWWDictionary<TKey, TValue>

| Improve this Doc View Source

NeedPruningFrom(UniqueAddress)

TBD

Declaration

public bool NeedPruningFrom(UniqueAddress removedNode)

Parameters

Type	Name	Description
UniqueAddress	removedNode	TBD

Returns

Type	Description
Boolean	TBD

| Improve this Doc View Source

Prune(UniqueAddress, UniqueAddress)

TBD

Declaration

public LWWDictionary<TKey, TValue> Prune(UniqueAddress removedNode, UniqueAddress collapseInto)

Parameters

Type	Name	Description
UniqueAddress	removedNode	TBD
UniqueAddress	collapseInto	TBD

Returns

Type	Description
LWWDictionary<TKey, TValue>	TBD

| Improve this Doc View Source

PruningCleanup(UniqueAddress)

TBD

Declaration

public LWWDictionary<TKey, TValue> PruningCleanup(UniqueAddress removedNode)

Parameters

Type	Name	Description
UniqueAddress	removedNode	TBD

Returns

Type	Description
LWWDictionary<TKey, TValue>	TBD

| Improve this Doc View Source

Remove(Cluster, TKey)

Removes an entry from the map. Note that if there is a conflicting update on another node the entry will not be removed after merge.

Declaration

public LWWDictionary<TKey, TValue> Remove(Cluster node, TKey key)

Parameters

Type	Name	Description
Cluster	node
TKey	key

Returns

Type	Description
LWWDictionary<TKey, TValue>

| Improve this Doc View Source

Remove(UniqueAddress, TKey)

Removes an entry from the map. Note that if there is a conflicting update on another node the entry will not be removed after merge.

Declaration

public LWWDictionary<TKey, TValue> Remove(UniqueAddress node, TKey key)

Parameters

Type	Name	Description
UniqueAddress	node
TKey	key

Returns

Type	Description
LWWDictionary<TKey, TValue>

| Improve this Doc View Source

ResetDelta()

Declaration

public LWWDictionary<TKey, TValue> ResetDelta()

Returns

Type	Description
LWWDictionary<TKey, TValue>

| Improve this Doc View Source

SetItem(Cluster, TKey, TValue, Clock<TValue>)

Adds an entry to the map.

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

Declaration

public LWWDictionary<TKey, TValue> SetItem(Cluster node, TKey key, TValue value, Clock<TValue> clock = null)

Parameters

Type	Name	Description
Cluster	node
TKey	key
TValue	value
Clock<TValue>	clock

Returns

Type	Description
LWWDictionary<TKey, TValue>

| Improve this Doc View Source

SetItem(UniqueAddress, TKey, TValue, Clock<TValue>)

Adds an entry to the map.

Declaration

public LWWDictionary<TKey, TValue> SetItem(UniqueAddress node, TKey key, TValue value, Clock<TValue> clock = null)

Parameters

Type	Name	Description
UniqueAddress	node
TKey	key
TValue	value
Clock<TValue>	clock

Returns

Type	Description
LWWDictionary<TKey, TValue>

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

| Improve this Doc View Source

TryGetValue(TKey, out TValue)

Tries to return a value under provided key is such value exists.

Declaration

public bool TryGetValue(TKey key, out TValue value)

Parameters

Type	Name	Description
TKey	key	TBD
TValue	value	TBD

Returns

Type	Description
Boolean	TBD

Explicit Interface Implementations

| Improve this Doc View Source

IDeltaReplicatedData.Delta

Declaration

IReplicatedDelta IDeltaReplicatedData.Delta { get; }

Returns

Type	Description
IReplicatedDelta

| Improve this Doc View Source

IDeltaReplicatedData.MergeDelta(IReplicatedDelta)

Declaration

IReplicatedData IDeltaReplicatedData.MergeDelta(IReplicatedDelta delta)

Parameters

Type	Name	Description
IReplicatedDelta	delta

Returns

Type	Description
IReplicatedData

| Improve this Doc View Source

IDeltaReplicatedData.ResetDelta()

Declaration

IReplicatedData IDeltaReplicatedData.ResetDelta()

Returns

Type	Description
IReplicatedData

| Improve this Doc View Source

IRemovedNodePruning.Prune(UniqueAddress, UniqueAddress)

Declaration

IReplicatedData IRemovedNodePruning.Prune(UniqueAddress removedNode, UniqueAddress collapseInto)

Parameters

Type	Name	Description
UniqueAddress	removedNode
UniqueAddress	collapseInto

Returns

Type	Description
IReplicatedData

| Improve this Doc View Source

IRemovedNodePruning.PruningCleanup(UniqueAddress)

Declaration

IReplicatedData IRemovedNodePruning.PruningCleanup(UniqueAddress removedNode)

Parameters

Type	Name	Description
UniqueAddress	removedNode

Returns

Type	Description
IReplicatedData

| Improve this Doc View Source

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
IEnumerator

Implements

IDeltaReplicatedData<T, TDelta>

IDeltaReplicatedData

IRemovedNodePruning<T>

IRemovedNodePruning

IReplicatedData<T>

IReplicatedData

IReplicatedDataSerialization

IEquatable<T>

IEnumerable<T>

IEnumerable

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(Object)

Extensions.Drop<T>(IEnumerable<T>, Int32)

Extensions.Head<T>(IEnumerable<T>)

Extensions.Concat<T>(IEnumerable<T>, T)

Extensions.ForEach<T>(IEnumerable<T>, Action<T>)

Extensions.TakeRight<T>(IEnumerable<T>, Int32)

EnumerableExtensions.Grouped<T>(IEnumerable<T>, Int32)