ORDictionary(TKey, TValue) Class

ORDictionaryTKey, TValue Class

Implements a 'Observed Remove Map' CRDT, also called a 'OR-Map'. It has similar semantics as an ORSetT, but in case of concurrent updates the values are merged, and must therefore be IReplicatedData types themselves. This class is immutable, i.e. "modifying" methods return a new instance.

Inheritance Hierarchy

SystemObject
Akka.DistributedDataORDictionaryTKey, TValue

Namespace: Akka.DistributedData
Assembly: Akka.DistributedData (in Akka.DistributedData.dll) Version: 1.2.3.42 (1.2.3.42)

Syntax

Copy

[SerializableAttribute]
public class ORDictionary<TKey, TValue> : IReplicatedData<ORDictionary<TKey, TValue>>, 
	IReplicatedData, IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable, 
	IRemovedNodePruning<ORDictionary<TKey, TValue>>, IEquatable<ORDictionary<TKey, TValue>>, 
	IReplicatedDataSerialization
where TValue : IReplicatedData

[<SerializableAttribute>]
type ORDictionary<'TKey, 'TValue when 'TValue : IReplicatedData> =  
    class
        interface IReplicatedData<ORDictionary<'TKey, 'TValue>>
        interface IReplicatedData
        interface IEnumerable<KeyValuePair<'TKey, 'TValue>>
        interface IEnumerable
        interface IRemovedNodePruning<ORDictionary<'TKey, 'TValue>>
        interface IEquatable<ORDictionary<'TKey, 'TValue>>
        interface IReplicatedDataSerialization
    end

Type Parameters

TKey: [Missing <typeparam name="TKey"/> documentation for "T:Akka.DistributedData.ORDictionary`2"]
TValue: [Missing <typeparam name="TValue"/> documentation for "T:Akka.DistributedData.ORDictionary`2"]

The ORDictionaryTKey, TValue type exposes the following members.

Constructors

	Name	Description
	ORDictionaryTKey, TValue	Creates a new instance of the ORDictionaryTKey, TValue class.

Top

Properties

	Name	Description
	Count	Returns number of entries stored within current ORDictionaryTKey, TValue
	Entries	Returns all entries stored within current ORDictionaryTKey, TValue
	IsEmpty	Determines if current ORDictionaryTKey, TValue doesn't contain any value.
	Item	Returns an element stored under provided key.
	Keys	Returns all keys stored within current ORDictionaryTKey, TValue
	Values	Returns all values stored within current ORDictionaryTKey, TValue

Top

Methods

	Name	Description
	AddOrUpdate(Cluster, TKey, TValue, FuncTValue, TValue)	Replace a value by applying the modify function on the existing value. If there is no current value for the key the initial value will be passed to the modify function.
	AddOrUpdate(UniqueAddress, TKey, TValue, FuncTValue, TValue)	Replace a value by applying the modify function on the existing value. If there is no current value for the key the initial value will be passed to the modify function.
	ContainsKey	Checks if provided key can be found inside current ORDictionaryTKey, TValue
	Equals(Object)	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object).)
	Equals(ORDictionaryTKey, TValue)	Indicates whether the current object is equal to another object of the same type.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Merge(IReplicatedData)
	Merge(ORDictionaryTKey, TValue)
	NeedPruningFrom
	Prune
	PruningCleanup
	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.
	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.
	SetItem(Cluster, TKey, TValue)	Adds an entry to the map. Note that the new value will be merged with existing values on other nodes and the outcome depends on what IReplicatedData type that is used. Consider using AddOrUpdate(Cluster, TKey, TValue, FuncTValue, TValue) instead of SetItem(Cluster, TKey, TValue) if you want modify existing entry. ArgumentException is thrown if you try to replace an existing ORSetT value, because important history can be lost when replacing the `ORSet` and undesired effects of merging will occur. Use ORMultiDictionaryTKey, TValue or AddOrUpdate(Cluster, TKey, TValue, FuncTValue, TValue) instead.
	SetItem(UniqueAddress, TKey, TValue)	Adds an entry to the map. Note that the new value will be merged with existing values on other nodes and the outcome depends on what IReplicatedData type that is used. Consider using AddOrUpdate(Cluster, TKey, TValue, FuncTValue, TValue) instead of SetItem(UniqueAddress, TKey, TValue) if you want modify existing entry. ArgumentException is thrown if you try to replace an existing ORSetT value, because important history can be lost when replacing the `ORSet` and undesired effects of merging will occur. Use ORMultiDictionaryTKey, TValue or AddOrUpdate(Cluster, TKey, TValue, FuncTValue, TValue) instead.
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	TryGetValue	Tries to retrieve value under provided key, returning true if value under that key has been found.

Top

Fields

	Name	Description
	Empty	An empty instance of the ORDictionaryTKey, TValue

Top

Extension Methods

	Name	Description
	AsInstanceOfT	TBD (Defined by Extensions.)
	ConcatKeyValuePairTKey, TValue	TBD (Defined by Extensions.)
	DropKeyValuePairTKey, TValue	Scala alias for Skip (Defined by Extensions.)
	ForEachKeyValuePairTKey, TValue	Applies a delegate action to all elements of this enumerable. (Defined by Extensions.)
	GroupedKeyValuePairTKey, TValue	Partitions elements in fixed size Credits to http://stackoverflow.com/a/13731854/465132 (Defined by EnumerableExtensions.)
	HeadKeyValuePairTKey, TValue	Scala alias for FirstOrDefault (Defined by Extensions.)
	IteratorKeyValuePairTKey, TValue	TBD (Defined by EnumeratorExtensions.)
	Match	Overloaded. Matches the specified target. (Defined by PatternMatch.)
	MatchT	Overloaded. Matches the specified target and return a result of target processing. (Defined by PatternMatch.)
	ShouldBeKeyValuePairTKey, TValue	TBD (Defined by AkkaSpecExtensions.)
	ShouldOnlyContainInOrderKeyValuePairTKey, TValue	TBD (Defined by AkkaSpecExtensions.)
	TakeRightKeyValuePairTKey, TValue	Selects last n elements. (Defined by Extensions.)

Top

Reference

Akka.DistributedData Namespace