xtd 0.2.0
thread_pool.hpp
Go to the documentation of this file.
1
4#pragma once
6#include "semaphore.hpp"
7#include "thread.hpp"
8#include "wait_callback.hpp"
10#include "../core_export.hpp"
11#include "../new_ptr.hpp"
12#include "../static.hpp"
13#include "../time_span.hpp"
14#include "../types.hpp"
15
17namespace xtd {
19 namespace threading {
53 friend class registered_wait_handle;
54
55 struct static_data;
56
57 template<class callback_t>
58 class thread_item : public object {
59 struct sdata {
60 sdata() = default;
61 sdata(sdata&&) = default;
62 sdata(const sdata&) = default;
63 sdata& operator =(sdata&&) = default;
64 sdata& operator =(const sdata&) = default;
65 sdata(const callback_t& callback) : callback {callback} {}
66 sdata(const callback_t& callback, const xtd::any_object& state) : callback {callback}, state {state} {}
67 sdata(const callback_t& callback, const xtd::any_object& state, wait_handle* wait_object, int32 milliseconds_timeout_interval, bool execute_only_once) : callback {callback}, state {state}, wait_object {wait_object}, milliseconds_timeout_interval {milliseconds_timeout_interval}, execute_only_once {execute_only_once} {}
68
69 callback_t callback;
70 xtd::any_object state;
71 wait_handle* wait_object = null;
72 int32 milliseconds_timeout_interval;
73 bool execute_only_once = true;
74 bool unregistered = false;
75 };
76
77 public:
78 thread_item() = default;
79 thread_item(thread_item&&) = default;
80 thread_item(const thread_item& other) {*data = *other.data;}
81 thread_item& operator =(thread_item&&) = default;
82 thread_item& operator =(const thread_item& other) {*data = *other.data; return *this;}
83 thread_item(const callback_t& callback) : data {xtd::new_ptr<sdata>(callback)} {}
84 thread_item(const callback_t& callback, const xtd::any_object& state) : data {xtd::new_ptr<sdata>(callback, state)} {}
85 thread_item(const callback_t& callback, const xtd::any_object& state, wait_handle& wait_object, int32 milliseconds_timeout_interval, bool execute_only_once) : data {xtd::new_ptr<sdata>(callback, state, &wait_object, milliseconds_timeout_interval, execute_only_once)} {}
86
87 bool execute_only_once() const noexcept {return data->execute_only_once;}
88 int32 milliseconds_timeout_interval() const noexcept {return data->milliseconds_timeout_interval;}
89 bool unregistered() const noexcept {return data->unregistered;}
90 void unregistered(bool value) noexcept {data->unregistered = value;}
91 wait_handle* wait_object() noexcept {return data->wait_object;}
92
93 void run() {data->callback(data->state);}
94 void run(bool timeout) {data->callback(data->state, timeout);}
95
96 private:
97 ptr<sdata> data = xtd::new_ptr<sdata>();
98 };
99
100 using thread_pool_item = thread_item<wait_callback>;
101 using thread_pool_asynchronous_io_item = thread_item<wait_or_timer_callback>;
104
105 public:
107
114 static void close();
115
120 static void get_available_threads(size_t& worker_threads, size_t& completion_port_threads);
121
128 static void get_max_threads(size_t& worker_threads, size_t& completion_port_threads);
129
133 static void get_min_threads(size_t& worker_threads, size_t& completion_port_threads);
134
140 static void join_all();
146 static bool join_all(int32 milliseconds_timeout);
152 static bool join_all(const time_span& timeout);
153
157 static bool queue_user_work_item(const wait_callback& callback);
162 static bool queue_user_work_item(const wait_callback& callback, const xtd::any_object& state);
163
165 template<class callback_t>
166 static bool queue_user_work_item(callback_t callback) {return queue_user_work_item(wait_callback {callback});}
167 template<class callback_t>
168 static bool queue_user_work_item(callback_t callback, const xtd::any_object& state) {return queue_user_work_item(wait_callback {callback}, state);}
170
179 static registered_wait_handle register_wait_for_single_object(wait_handle& wait_object, const wait_or_timer_callback& callback, const xtd::any_object& state, int32 milliseconds_timeout_interval, bool execute_only_once);
188 static registered_wait_handle register_wait_for_single_object(wait_handle& wait_object, const wait_or_timer_callback& callback, const xtd::any_object& state, int64 milliseconds_timeout_interval, bool execute_only_once);
197 static registered_wait_handle register_wait_for_single_object(wait_handle& wait_object, const wait_or_timer_callback& callback, const xtd::any_object& state, const time_span& timeout, bool execute_only_once);
206 static registered_wait_handle register_wait_for_single_object(wait_handle& wait_object, const wait_or_timer_callback& callback, const xtd::any_object& state, uint32 milliseconds_timeout_interval, bool execute_only_once);
207
209 template<class callback_t>
210 static registered_wait_handle register_wait_for_single_object(wait_handle& wait_object, callback_t callback, const xtd::any_object& state, int32 milliseconds_timeout_interval, bool execute_only_once) {return register_wait_for_single_object(wait_object, wait_or_timer_callback {callback}, state, milliseconds_timeout_interval, execute_only_once);}
211 template<class callback_t>
212 static registered_wait_handle register_wait_for_single_object(wait_handle& wait_object, callback_t callback, const xtd::any_object& state, int64 milliseconds_timeout_interval, bool execute_only_once) {return register_wait_for_single_object(wait_object, wait_or_timer_callback {callback}, state, milliseconds_timeout_interval, execute_only_once);}
213 template<class callback_t>
214 static registered_wait_handle register_wait_for_single_object(wait_handle& wait_object, callback_t callback, const xtd::any_object& state, const time_span& timeout, bool execute_only_once) {return register_wait_for_single_object(wait_object, wait_or_timer_callback {callback}, state, timeout, execute_only_once);}
215 template<class callback_t>
216 static registered_wait_handle register_wait_for_single_object(wait_handle& wait_object, callback_t callback, const xtd::any_object& state, uint32 milliseconds_timeout_interval, bool execute_only_once) {return register_wait_for_single_object(wait_object, wait_or_timer_callback {callback}, state, milliseconds_timeout_interval, execute_only_once);}
218
223 static bool set_max_threads(size_t worker_threads, size_t completion_port_threads);
224
229 static bool set_min_threads(size_t worker_threads, size_t completion_port_threads);
231
232 private:
233 friend class xtd::threading::thread;
234 static void asynchronous_io_run();
235 static void create_thread();
236 static void create_asynchronous_io_thread();
237 static void initialize_min_threads();
238 static void initialize_min_asynchronous_io_threads();
239 static bool join_all_threads(int32 milliseconds_timeout);
240 static bool join_all_asynchronous_io_threads(int32 milliseconds_timeout);
241 static void run();
242
243 static size_t max_threads_;
244 static size_t max_asynchronous_io_threads_;
245 static size_t min_threads_;
246 static size_t min_asynchronous_io_threads_;
247 static static_data static_data_;
248 };
249 }
250}
251
253// Add xtd::delegate::begin_invoke and xtd::delegate::end_invoke methods.
254#define __XTD_CORE_INTERNAL__
255#include "../internal/__delegate.hpp"
256#undef __XTD_CORE_INTERNAL__
Represent a polymorphic wrapper capable of holding any type.
Definition any_object.hpp:29
Represents a strongly typed list of objects that can be accessed by index. Provides methods to search...
Definition list.hpp:80
Supports all classes in the xtd class hierarchy and provides low-level services to derived classes....
Definition object.hpp:43
The xtd::shared_ptr_object is a shared pointer as std::shared_ptr.
Definition shared_ptr_object.hpp:30
A synchronization primitive that can also be used for interprocess synchronization.
Definition registered_wait_handle.hpp:29
Provides a pool of threads that can be used to execute tasks, post work items, process asynchronous I...
Definition thread_pool.hpp:52
static bool queue_user_work_item(const wait_callback &callback, const xtd::any_object &state)
Queues a method for execution. The method executes when a thread pool thread becomes available.
static registered_wait_handle register_wait_for_single_object(wait_handle &wait_object, const wait_or_timer_callback &callback, const xtd::any_object &state, int64 milliseconds_timeout_interval, bool execute_only_once)
Registers a delegate to wait for a xtd::threading::wait_handle, specifying a 32-bit signed integer fo...
static bool set_max_threads(size_t worker_threads, size_t completion_port_threads)
Sets the number of requests to the thread pool that can be active concurrently. All requests above th...
static registered_wait_handle register_wait_for_single_object(wait_handle &wait_object, const wait_or_timer_callback &callback, const xtd::any_object &state, const time_span &timeout, bool execute_only_once)
Registers a delegate to wait for a xtd::threading::wait_handle, specifying a 32-bit signed integer fo...
static void join_all()
Join all resources and worker threads.
static bool join_all(int32 milliseconds_timeout)
Join all resources and worker threads.
static bool set_min_threads(size_t worker_threads, size_t completion_port_threads)
Sets the number of idle threads the thread pool maintains in anticipation of new requests.
static bool join_all(const time_span &timeout)
Join all resources and worker threads.
static void close()
Close all resources and worker threads.
static bool queue_user_work_item(const wait_callback &callback)
Queues a method for execution. The method executes when a thread pool thread becomes available.
static void get_min_threads(size_t &worker_threads, size_t &completion_port_threads)
Retrieves the number of idle threads the thread pool maintains in anticipation of new requests....
static registered_wait_handle register_wait_for_single_object(wait_handle &wait_object, const wait_or_timer_callback &callback, const xtd::any_object &state, uint32 milliseconds_timeout_interval, bool execute_only_once)
Registers a delegate to wait for a xtd::threading::wait_handle, specifying a 32-bit signed integer fo...
static void get_available_threads(size_t &worker_threads, size_t &completion_port_threads)
Retrieves the difference between the maximum number of thread pool threads returned by the GetMaxThre...
static registered_wait_handle register_wait_for_single_object(wait_handle &wait_object, const wait_or_timer_callback &callback, const xtd::any_object &state, int32 milliseconds_timeout_interval, bool execute_only_once)
Registers a delegate to wait for a xtd::threading::wait_handle, specifying a 32-bit signed integer fo...
static void get_max_threads(size_t &worker_threads, size_t &completion_port_threads)
Retrieves the number of requests to the thread pool that can be active concurrently....
Creates and controls a thread, sets its priority, and gets its status.
Definition thread.hpp:45
Contains a constant used to specify an infinite amount of time. This class cannot be inherited.
Definition timeout.hpp:33
Encapsulates operating system specific objects that wait for exclusive access to shared resources.
Definition wait_handle.hpp:52
Represents a time interval.
Definition time_span.hpp:29
xtd::delegate< void(const xtd::any_object &state)> wait_callback
Represents a callback method to be executed by a thread pool thread.
Definition wait_callback.hpp:30
xtd::delegate< void(const xtd::any_object &state, bool timed_out)> wait_or_timer_callback
Represents a method to be called when a xtd::threading::wait_handle is signaled or times out.
Definition wait_or_timer_callback.hpp:30
#define static_
This keyword is use to represent a static object. A static object can't be instantiated (constructors...
Definition static.hpp:37
#define core_export_
Define shared library export.
Definition core_export.hpp:13
int32_t int32
Represents a 32-bit signed integer.
Definition int32.hpp:23
int64_t int64
Represents a 64-bit signed integer.
Definition int64.hpp:23
null_ptr null
Represents a null pointer value.
uint32_t uint32
Represents a 32-bit unsigned integer.
Definition uint32.hpp:23
@ other
The operating system is other.
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition xtd_about_box.hpp:10
Contains xtd::threading::registered_wait_handle exception.
Contains xtd::threading::thread class.
Contains xtd::threading::semaphore exception.
Contains xtd::threading::wait_callback delegate.
Contains xtd::threading::wait_or_timer_callback delegate.