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...

#include <thread_pool.h>

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
	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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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...

Static Public Member Functions
static ThreadPoolImpl &	GetInstance ()
	Implementation instance that holds list of jobs and other parameters. More...

static bool	QueueUserWorkItem (WaitCallback callback)
	Puts work item into queue which is present with callback with no parameter. More...

static 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 void	GetAvailableThreads (int &wt, int &cpt)
	Gets number of available threads. More...

static void	GetMaxThreads (int &wt, int &cpt)
	Gets maximal number of concurrent threads. More...

static void	GetMinThreads (int &wt, int &cpt)
	Gets minimal number of threads being created by pool. More...

static bool	SetMaxThreads (int wt, int cpt)
	Sets number of threads owned by pool. More...

static bool	SetMinThreads (int wt, int cpt)
	Sets minimal number of threads owned by pool. More...

static 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 TypeInfo &	Type ()
	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...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. 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.

#include "system/threading/thread_pool.h"
#include "system/threading/thread.h"
#include "system/object.h"
#include "system/smart_ptr.h"
#include <iostream>
#include <mutex>
#include <string>
#include <thread>
 
const std::string &BooleanToString(bool value)
{
  static const std::string True = "True";
  static const std::string False = "False";
 
  return value ? True : False;
}
 
int main()
{
  using namespace System::Threading;
  std::mutex m;
 
  const auto threadsCount = std::thread::hardware_concurrency();
 
  for (unsigned int i = 0; i < threadsCount; ++i)
  {
    ThreadPool::QueueUserWorkItem([&m](System::SharedPtr<System::Object> object) -> void {
      auto thread = Thread::get_CurrentThread();
      m.lock();
      std::cout << "Background: " << BooleanToString(thread->get_IsBackground()) <<
        ", Thread pool: " << BooleanToString(thread->get_IsThreadPoolThread()) <<
        ", Thread ID: " << thread->get_ManagedThreadId() << std::endl;
      m.unlock();
    });
  }
 
  ThreadPool::JoinAllThreads();
 
  return 0;
}
/*
This code example produces the following output:
Background: True, Thread pool: True, Thread ID: 1
Background: True, Thread pool: True, Thread ID: 3
Background: True, Thread pool: True, Thread ID: 5
Background: True, Thread pool: True, Thread ID: 6
Background: True, Thread pool: True, Thread ID: 9
Background: True, Thread pool: True, Thread ID: 1
Background: True, Thread pool: True, Thread ID: 7
Background: True, Thread pool: True, Thread ID: 2
Background: True, Thread pool: True, Thread ID: 4
Background: True, Thread pool: True, Thread ID: 3
Background: True, Thread pool: True, Thread ID: 12
Background: True, Thread pool: True, Thread ID: 8
Background: True, Thread pool: True, Thread ID: 5
Background: True, Thread pool: True, Thread ID: 6
Background: True, Thread pool: True, Thread ID: 16
Background: True, Thread pool: True, Thread ID: 11
*/

Constructor & Destructor Documentation

◆ ThreadPool()

System::Threading::ThreadPool::ThreadPool ( const ThreadPool & )

delete

No copying.

Member Function Documentation

◆ GetAvailableThreads()

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

static

Gets number of available threads.

Parameters

wt	Reference to variable to store number of awailable worker threads.
cpt	Reference to variable to store number of awailable IO threads.

◆ GetInstance()

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

static

Implementation instance that holds list of jobs and other parameters.

Returns: Pool implementation object refernce.

◆ GetMaxThreads()

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

static

Gets maximal number of concurrent threads.

Parameters

wt	Reference to variable to store maximal number of awailable worker threads.
cpt	Reference to variable to store maximal number of awailable IO threads.

◆ GetMinThreads()

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

static

Gets minimal number of threads being created by pool.

Parameters

wt	Reference to variable to store minimal number of awailable worker threads.
cpt	Reference to variable to store minimal number of awailable IO threads.

◆ JoinAllThreads()

static 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 bool System::Threading::ThreadPool::QueueUserWorkItem ( WaitCallback callback )

static

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

Parameters

callback Callback function to be used as a job.

Returns: Always returns true.

◆ QueueUserWorkItem() [2/2]

static 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

callback	Callback function to be used as a job.
state	Job function parameter.

Returns: Always returns true.

◆ SetMaxThreads()

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

static

Sets number of threads owned by pool.

Parameters

wt	Maximal number of worker threads.
cpt	Maximal number of IO threads.

Returns: True if parameters were accepted, false otherwise.

◆ SetMinThreads()

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

static

Sets minimal number of threads owned by pool.

Parameters

wt	Minimal number of worker threads.
cpt	Minimal number of IO threads.

Returns: True if parameters were accepted, false otherwise.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ThreadPool()

Member Function Documentation

◆ GetAvailableThreads()

◆ GetInstance()

◆ GetMaxThreads()

◆ GetMinThreads()

◆ JoinAllThreads()

◆ operator=()

◆ QueueUserWorkItem() [1/2]

◆ QueueUserWorkItem() [2/2]

◆ SetMaxThreads()

◆ SetMinThreads()