Asposecpplib
System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue > Class Template Reference

Thread-safe dictionary implementation. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Collections::Generic::Dictionary< TKey, TValue >.

Public Types

using ThisType = ConcurrentDictionary< TKey, TValue >
 This type. More...
 
using BaseType = System::Collections::Generic::Dictionary< TKey, TValue >
 Implementation type. More...
 
- Public Types inherited from System::Collections::Generic::Dictionary< TKey, TValue >
typedef ICollection< TKey > KeyCollection
 Collection of keys to extract. More...
 
typedef ICollection< TValue > ValueCollection
 Collection of values to extract. More...
 
typedef std::unordered_map< TKey, TValue, EqualityComparerHashAdapter< TKey >, EqualityComparerAdapter< TKey >, ASPOSE_MAP_ALLOCATOR_TYPE(TKey, TValue)> map_t
 Underlying data type. More...
 
typedef SharedPtr< Dictionary< TKey, TValue > > Ptr
 Pointer type. More...
 
typedef KeyValuePair< TKey, TValue > KVPair
 Key-value pair type. More...
 
typedef SharedPtr< IEnumerable< KVPair > > IEnumerablePtr
 Pointer to enumerable interface. More...
 
typedef SharedPtr< IEnumerator< KVPair > > IEnumeratorPtr
 Pointer to enumerator. More...
 
- Public Types inherited from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >
typedef ICollection< KeyValuePair< map_t::key_type, map_t::mapped_type > > BaseType
 Base interface type. More...
 
typedef KeyValuePair< map_t::key_type, map_t::mapped_type > KeyValuePairType
 Key value pair type. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< T >
typedef T ValueType
 Value type name. More...
 
typedef ICollection< T > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< T >
typedef IEnumerator< T > IEnumeratorType
 Enumerator type. More...
 
using ValueType = T
 
using iterator = EnumeratorBasedIterator< T, IEnumerator< T > >
 
using const_iterator = iterator
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

virtual void idx_set (const TKey &key, TValue value) override
 Sets element at specific position. More...
 
virtual SharedPtr< typename ThisType::KeyCollectionget_KeysInternal () const override
 Gets wrapper collection to access dictionary keys. More...
 
virtual void Add (const TKey &key, const TValue &value) override
 Adds value into dictionary. More...
 
virtual void Clear () override
 Deletes all elements in container. More...
 
virtual void CopyTo (ArrayPtr< System::Collections::Generic::KeyValuePair< TKey, TValue >> arr, int index) override
 Copies container elements to existing array elements. More...
 
virtual bool Remove (const TKey &key) override
 Removes element from container. More...
 
- Public Member Functions inherited from System::Collections::Generic::Dictionary< TKey, TValue >
 Dictionary ()
 Creates empty dictionary. More...
 
 Dictionary (const map_t &map)
 Copies data from map. More...
 
 Dictionary (int capacity)
 Overload which corresponds to creating pre-allocated dictionary; does no allocation, actually. More...
 
 Dictionary (const SharedPtr< IDictionary< TKey, TValue > > &src)
 Copy constructor. More...
 
 Dictionary (const SharedPtr< IDictionary< TKey, TValue > > &src, const SharedPtr< IEqualityComparer< TKey > > &comparer)
 Copy constructor. More...
 
 Dictionary (const SharedPtr< IEqualityComparer< TKey > > &comparer)
 Creates empty dictionary. More...
 
 Dictionary (int capacity, const SharedPtr< IEqualityComparer< TKey > > &comparer)
 Creates empty dictionary. More...
 
virtual IEnumeratorPtr GetEnumerator () override
 Creates enumerator object. More...
 
- Public Member Functions inherited from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >
virtual SharedPtr< ICollection< map_t::key_type > > get_Keys () const
 Accesses key collection. More...
 
virtual SharedPtr< ICollection< map_t::mapped_type > > get_Values () const
 Accesses value collection. More...
 
bool get_IsFixedSize () const
 Checks if collection size is fixed. More...
 
bool get_IsSynchronized () const
 Checks if container is thread-safe. More...
 
virtual void CopyTo (ArrayPtr< KeyValuePair< map_t::key_type, map_t::mapped_type >> arr, int index) override
 Copies dictionary contents into existing array elements. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< T >
virtual void Add (const T &item)=0
 Adds element into collection. More...
 
virtual bool Contains (const T &item) const =0
 Checks if element is present in collection. More...
 
virtual bool Remove (const T &item)=0
 Deletes element from collection. More...
 
virtual bool get_IsReadOnly () const
 Checks if collection is read only. More...
 
virtual void CopyTo (System::ArrayPtr< T > array, int arrayIndex)=0
 Copies all collection elements to existing array elements. More...
 
ICollectionoperator= (ICollection &&)
 Move assignment operator. More...
 
ICollectionoperator= (const ICollection &)
 Move assignment operator. More...
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&)
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
SharedPtr< Objectget_SyncRoot () const
 Gets the object the collection is being synchronized through. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< T >
LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
LINQ_First ()
 Returns the first element of a sequence. More...
 
LINQ_First (const Func< T, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
LINQ_Last ()
 Returns the last element of a sequence. More...
 
LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< T > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< T, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< T > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(T)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(T)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (T value)
 Determines if a sequence contains a specified value. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderBy (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderByDescending (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 Transforms elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< T > > LINQ_Concat (SharedPtr< IEnumerable< T >> sequence)
 Concatenates two sequences. More...
 
template<typename Key >
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, T > > > > LINQ_GroupBy (System::Func< T, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< T, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

 ~ConcurrentDictionary () override
 Destructor. More...
 
virtual SharedPtr< typename ThisType::ValueCollectionget_ValuesInternal () const override
 Gets wrapper collection to access dictionary values. More...
 
- Protected Member Functions inherited from System::Collections::Generic::Dictionary< TKey, TValue >
 ~Dictionary () override
 Destructor. More...
 
SharedPtr< KeyCollectionget_KeysInternal () const override
 Implementation of internal keys collection accessor. More...
 
SharedPtr< ValueCollectionget_ValuesInternal () const override
 Implementation of internal value collection accessor. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >
 ~IDictionary () override
 Destructor. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

template<class TKey, class TValue>
class System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >

Thread-safe dictionary implementation. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

#include <system/collections/concurrent/concurrent_dictionary.h>
#include <system/smart_ptr.h>
using namespace System;
int main() {
const int itemsCount = 32;
// Create the ConcurrentDictionary-class instance.
auto concurrentDictionary = MakeObject<ConcurrentDictionary<int, int>>();
// Fill the concurrent dictionary.
for (auto i = 0; i < itemsCount; ++i) {
concurrentDictionary->Add(i, i * i);
}
Console::WriteLine(concurrentDictionary->idx_get(3));
return 0;
}
/*
This code example produces the following output:
9
*/
static void WriteLine()
Outputs the current line terminator to the standard output stream.
Definition: algorithms.h:10
Definition: db_command.h:9
Template Parameters
TKeyKey type.
TValueValue type.

Member Typedef Documentation

◆ BaseType

template<class TKey , class TValue >
using System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::BaseType = System::Collections::Generic::Dictionary<TKey, TValue>

Implementation type.

◆ ThisType

template<class TKey , class TValue >
using System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::ThisType = ConcurrentDictionary<TKey, TValue>

This type.

Constructor & Destructor Documentation

◆ ~ConcurrentDictionary()

template<class TKey , class TValue >
System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::~ConcurrentDictionary ( )
inlineoverrideprotected

Destructor.

Member Function Documentation

◆ Add()

template<class TKey , class TValue >
virtual void System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::Add ( const TKey &  key,
const TValue &  value 
)
inlineoverridevirtual

Adds value into dictionary.

Parameters
keyKey to add.
valueValue to add.

◆ Clear()

template<class TKey , class TValue >
virtual void System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::Clear ( )
inlineoverridevirtual

Deletes all elements in container.

Implements System::Collections::Generic::ICollection< T >.

◆ CopyTo()

template<class TKey , class TValue >
virtual void System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::CopyTo ( ArrayPtr< System::Collections::Generic::KeyValuePair< TKey, TValue >>  arr,
int  index 
)
inlineoverridevirtual

Copies container elements to existing array elements.

Parameters
arrDestination array.
indexIndex in destination array.

◆ get_KeysInternal()

template<class TKey , class TValue >
virtual SharedPtr<typename ThisType::KeyCollection> System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::get_KeysInternal ( ) const
inlineoverridevirtual

Gets wrapper collection to access dictionary keys.

Returns
Newly created collection to wrap collection's keys.

Reimplemented from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.

◆ get_ValuesInternal()

template<class TKey , class TValue >
virtual SharedPtr<typename ThisType::ValueCollection> System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::get_ValuesInternal ( ) const
inlineoverrideprotectedvirtual

Gets wrapper collection to access dictionary values.

Returns
Newly created collection to wrap collection's values.

Reimplemented from System::Collections::Generic::IDictionary< map_t::key_type, map_t::mapped_type >.

◆ idx_set()

template<class TKey , class TValue >
virtual void System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::idx_set ( const TKey &  key,
TValue  value 
)
inlineoverridevirtual

Sets element at specific position.

Parameters
keyPosition to set element at.
valueValue to set at specific position.

◆ Remove()

template<class TKey , class TValue >
virtual bool System::Collections::Concurrent::ConcurrentDictionary< TKey, TValue >::Remove ( const TKey &  key)
inlineoverridevirtual

Removes element from container.

Parameters
keyKey to remove element at.
Returns
True if element was found and removed, false otherwise.