Class PNCounterDictionary<TKey>

Map of named counters. Specialized ORDictionary<TKey, TValue> with PNCounter values. This class is immutable, i.e. "modifying" methods return a new instance.

Inheritance
Object
PNCounterDictionary<TKey>
Implements
Inherited Members
Namespace: Akka.DistributedData
Assembly: Akka.DistributedData.dll
Syntax
public sealed class PNCounterDictionary<TKey> : IDeltaReplicatedData<PNCounterDictionary<TKey>, ORDictionary<TKey, PNCounter>.IDeltaOperation>, IDeltaReplicatedData, IRemovedNodePruning<PNCounterDictionary<TKey>>, IRemovedNodePruning, IReplicatedData<PNCounterDictionary<TKey>>, IReplicatedData, IReplicatedDataSerialization, IEquatable<PNCounterDictionary<TKey>>, IEnumerable<KeyValuePair<TKey, BigInteger>>, IEnumerable
Type Parameters
Name Description
TKey

Constructors

| Improve this Doc View Source

PNCounterDictionary(ORDictionary<TKey, PNCounter>)

Declaration
public PNCounterDictionary(ORDictionary<TKey, PNCounter> underlying)
Parameters
Type Name Description
ORDictionary<TKey, PNCounter> underlying

Fields

| Improve this Doc View Source

Empty

Declaration
public static readonly PNCounterDictionary<TKey> Empty
Field Value
Type Description
PNCounterDictionary<TKey>

Properties

| Improve this Doc View Source

Count

Returns number of entries stored within current PNCounterDictionary<TKey>.

Declaration
public int Count { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Delta

Declaration
public ORDictionary<TKey, PNCounter>.IDeltaOperation Delta { get; }
Property Value
Type Description
ORDictionary.IDeltaOperation<>
| Improve this Doc View Source

Entries

Returns all entries stored within current PNCounterDictionary<TKey>

Declaration
public IImmutableDictionary<TKey, BigInteger> Entries { get; }
Property Value
Type Description
System.Collections.Immutable.IImmutableDictionary<TKey, BigInteger>
| Improve this Doc View Source

IsEmpty

Determines if current PNCounterDictionary<TKey> is empty.

Declaration
public bool IsEmpty { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Item[TKey]

Returns a counter value stored within current PNCounterDictionary<TKey> under provided key

Declaration
public BigInteger this[TKey key] { get; }
Parameters
Type Name Description
TKey key
Property Value
Type Description
BigInteger
| Improve this Doc View Source

Keys

Returns all keys of the current PNCounterDictionary<TKey>.

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 all values stored within current PNCounterDictionary<TKey>.

Declaration
public IEnumerable<BigInteger> Values { get; }
Property Value
Type Description
IEnumerable<BigInteger>

Methods

| Improve this Doc View Source

ContainsKey(TKey)

Determines if current PNCounterDictionary<TKey> has a counter registered under provided key.

Declaration
public bool ContainsKey(TKey key)
Parameters
Type Name Description
TKey key
Returns
Type Description
Boolean
| Improve this Doc View Source

Decrement(Cluster, TKey, Int64)

Decrement the counter with the delta specified. If the delta is negative then it will increment instead of decrement.

Declaration
public PNCounterDictionary<TKey> Decrement(Cluster node, TKey key, long delta = 1L)
Parameters
Type Name Description
Cluster node
TKey key
Int64 delta
Returns
Type Description
PNCounterDictionary<TKey>
| Improve this Doc View Source

Decrement(UniqueAddress, TKey, Int64)

Decrement the counter with the delta specified. If the delta is negative then it will increment instead of decrement.

Declaration
public PNCounterDictionary<TKey> Decrement(UniqueAddress node, TKey key, long delta = 1L)
Parameters
Type Name Description
UniqueAddress node
TKey key
Int64 delta
Returns
Type Description
PNCounterDictionary<TKey>
| Improve this Doc View Source

Equals(PNCounterDictionary<TKey>)

Declaration
public bool Equals(PNCounterDictionary<TKey> other)
Parameters
Type Name Description
PNCounterDictionary<TKey> other
Returns
Type Description
Boolean
| 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
| Improve this Doc View Source

GetEnumerator()

Declaration
public IEnumerator<KeyValuePair<TKey, BigInteger>> GetEnumerator()
Returns
Type Description
IEnumerator<KeyValuePair<TKey, BigInteger>>
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

Increment(Cluster, TKey, Int64)

Increment the counter with the delta specified. If the delta is negative then it will decrement instead of increment.

Declaration
public PNCounterDictionary<TKey> Increment(Cluster node, TKey key, long delta = 1L)
Parameters
Type Name Description
Cluster node
TKey key
Int64 delta
Returns
Type Description
PNCounterDictionary<TKey>
| Improve this Doc View Source

Increment(UniqueAddress, TKey, Int64)

Increment the counter with the delta specified. If the delta is negative then it will decrement instead of increment.

Declaration
public PNCounterDictionary<TKey> Increment(UniqueAddress node, TKey key, long delta = 1L)
Parameters
Type Name Description
UniqueAddress node
TKey key
Int64 delta
Returns
Type Description
PNCounterDictionary<TKey>
| Improve this Doc View Source

Merge(IReplicatedData)

Declaration
public IReplicatedData Merge(IReplicatedData other)
Parameters
Type Name Description
IReplicatedData other
Returns
Type Description
IReplicatedData
| Improve this Doc View Source

Merge(PNCounterDictionary<TKey>)

Declaration
public PNCounterDictionary<TKey> Merge(PNCounterDictionary<TKey> other)
Parameters
Type Name Description
PNCounterDictionary<TKey> other
Returns
Type Description
PNCounterDictionary<TKey>
| Improve this Doc View Source

MergeDelta(ORDictionary<TKey, PNCounter>.IDeltaOperation)

Declaration
public PNCounterDictionary<TKey> MergeDelta(ORDictionary<TKey, PNCounter>.IDeltaOperation delta)
Parameters
Type Name Description
ORDictionary.IDeltaOperation<> delta
Returns
Type Description
PNCounterDictionary<TKey>
| Improve this Doc View Source

NeedPruningFrom(UniqueAddress)

Declaration
public bool NeedPruningFrom(UniqueAddress removedNode)
Parameters
Type Name Description
UniqueAddress removedNode
Returns
Type Description
Boolean
| Improve this Doc View Source

Prune(UniqueAddress, UniqueAddress)

Declaration
public PNCounterDictionary<TKey> Prune(UniqueAddress removedNode, UniqueAddress collapseInto)
Parameters
Type Name Description
UniqueAddress removedNode
UniqueAddress collapseInto
Returns
Type Description
PNCounterDictionary<TKey>
| Improve this Doc View Source

PruningCleanup(UniqueAddress)

Declaration
public PNCounterDictionary<TKey> PruningCleanup(UniqueAddress removedNode)
Parameters
Type Name Description
UniqueAddress removedNode
Returns
Type Description
PNCounterDictionary<TKey>
| 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 PNCounterDictionary<TKey> Remove(Cluster node, TKey key)
Parameters
Type Name Description
Cluster node
TKey key
Returns
Type Description
PNCounterDictionary<TKey>
| 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 PNCounterDictionary<TKey> Remove(UniqueAddress node, TKey key)
Parameters
Type Name Description
UniqueAddress node
TKey key
Returns
Type Description
PNCounterDictionary<TKey>
| Improve this Doc View Source

ResetDelta()

Declaration
public PNCounterDictionary<TKey> ResetDelta()
Returns
Type Description
PNCounterDictionary<TKey>
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides
| Improve this Doc View Source

TryGetValue(TKey, out BigInteger)

Tries to return a value under provided key, if such entry exists.

Declaration
public bool TryGetValue(TKey key, out BigInteger value)
Parameters
Type Name Description
TKey key
BigInteger value
Returns
Type Description
Boolean

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

Extension Methods