Asposecpplib
System::Threading::ThreadPool Class Reference

Thread pool API allowing it pushing jobs into queue to be read by pool of worker threads. This is a static type with no instance services. You should never create instances of it by any means. More...

Inherits System::Object.

Public Member Functions

 ThreadPool (const ThreadPool &)=delete
 No copying. More...
 
void operator= (const ThreadPool &)=delete
 No copying. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API 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 refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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...
 

Static Public Member Functions

static ASPOSECPP_SHARED_API ThreadPoolImplGetInstance ()
 Implementation instance that holds list of jobs and other parameters. More...
 
static ASPOSECPP_SHARED_API bool QueueUserWorkItem (WaitCallback callback)
 Puts work item into queue which is present with callback with no parameter. More...
 
static ASPOSECPP_SHARED_API bool QueueUserWorkItem (WaitCallback callback, const System::SharedPtr< System::Object > &state)
 Puts work item into queue which is present with callback with no parameter. More...
 
static ASPOSECPP_SHARED_API void GetAvailableThreads (int &wt, int &cpt)
 Gets number of available threads. More...
 
static ASPOSECPP_SHARED_API void GetMaxThreads (int &wt, int &cpt)
 Gets maximal number of concurrent threads. More...
 
static ASPOSECPP_SHARED_API void GetMinThreads (int &wt, int &cpt)
 Gets minimal number of threads being created by pool. More...
 
static ASPOSECPP_SHARED_API bool SetMaxThreads (int wt, int cpt)
 Sets number of threads owned by pool. More...
 
static ASPOSECPP_SHARED_API bool SetMinThreads (int wt, int cpt)
 Sets minimal number of threads owned by pool. More...
 
static ASPOSECPP_SHARED_API void JoinAllThreads ()
 Joins all owned threads. Waits infinitely. More...
 
- 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 ()
 Impleemnts 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...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 

Detailed Description

Thread pool API allowing it pushing jobs into queue to be read by pool of worker threads. This is a static type with no instance services. You should never create instances of it by any means.

Constructor & Destructor Documentation

◆ ThreadPool()

System::Threading::ThreadPool::ThreadPool ( const ThreadPool )
delete

No copying.

Member Function Documentation

◆ GetAvailableThreads()

static ASPOSECPP_SHARED_API void System::Threading::ThreadPool::GetAvailableThreads ( int &  wt,
int &  cpt 
)
static

Gets number of available threads.

Parameters
wtReference to variable to store number of awailable worker threads.
cptReference to variable to store number of awailable IO threads.

◆ GetInstance()

static ASPOSECPP_SHARED_API ThreadPoolImpl& System::Threading::ThreadPool::GetInstance ( )
static

Implementation instance that holds list of jobs and other parameters.

Returns
Pool implementation object refernce.

◆ GetMaxThreads()

static ASPOSECPP_SHARED_API void System::Threading::ThreadPool::GetMaxThreads ( int &  wt,
int &  cpt 
)
static

Gets maximal number of concurrent threads.

Parameters
wtReference to variable to store maximal number of awailable worker threads.
cptReference to variable to store maximal number of awailable IO threads.

◆ GetMinThreads()

static ASPOSECPP_SHARED_API void System::Threading::ThreadPool::GetMinThreads ( int &  wt,
int &  cpt 
)
static

Gets minimal number of threads being created by pool.

Parameters
wtReference to variable to store minimal number of awailable worker threads.
cptReference to variable to store minimal number of awailable IO threads.

◆ JoinAllThreads()

static ASPOSECPP_SHARED_API void System::Threading::ThreadPool::JoinAllThreads ( )
static

Joins all owned threads. Waits infinitely.

◆ operator=()

void System::Threading::ThreadPool::operator= ( const ThreadPool )
delete

No copying.

◆ QueueUserWorkItem() [1/2]

static ASPOSECPP_SHARED_API bool System::Threading::ThreadPool::QueueUserWorkItem ( WaitCallback  callback)
static

Puts work item into queue which is present with callback with no parameter.

Parameters
callbackCallback function to be used as a job.
Returns
Always returns true.

◆ QueueUserWorkItem() [2/2]

static ASPOSECPP_SHARED_API bool System::Threading::ThreadPool::QueueUserWorkItem ( WaitCallback  callback,
const System::SharedPtr< System::Object > &  state 
)
static

Puts work item into queue which is present with callback with no parameter.

Parameters
callbackCallback function to be used as a job.
stateJob function parameter.
Returns
Always returns true.

◆ SetMaxThreads()

static ASPOSECPP_SHARED_API bool System::Threading::ThreadPool::SetMaxThreads ( int  wt,
int  cpt 
)
static

Sets number of threads owned by pool.

Parameters
wtMaximal number of worker threads.
cptMaximal number of IO threads.
Returns
True if parameters were accepted, false otherwise.

◆ SetMinThreads()

static ASPOSECPP_SHARED_API bool System::Threading::ThreadPool::SetMinThreads ( int  wt,
int  cpt 
)
static

Sets minimal number of threads owned by pool.

Parameters
wtMinimal number of worker threads.
cptMinimal number of IO threads.
Returns
True if parameters were accepted, false otherwise.