xtd 0.2.0
wait_handle.hpp
Go to the documentation of this file.
1
4#pragma once
5
6#include "timeout.hpp"
7#include "../abstract.hpp"
8#include "../as.hpp"
9#include "../size_object.hpp"
10#include "../time_span.hpp"
11#include "../types.hpp"
12#include <limits>
13#include <vector>
14
16namespace xtd {
18 namespace threading {
20 class registered_wait_handle;
21 class thread;
23
52 class core_export_ wait_handle abstract_ {
53 friend class registered_wait_handle;
54 friend class thread;
55 public:
57
63 static const intptr invalid_handle;
64
67 static constexpr size_t wait_timeout = size_object::max_value;
69
71
74 wait_handle() = default;
76
78 ~wait_handle();
80
82
86 virtual intptr handle() const noexcept = 0;
89 virtual void handle(intptr value) = 0;
91
93
97 virtual void close();
98
103 virtual bool wait_one();
104
111 virtual bool wait_one(int32 milliseconds_timeout);
112
119 virtual bool wait_one(const time_span& timeout);
121
123
132 static bool signal_and_wait(wait_handle& to_signal, wait_handle& to_wait);
133
142 static bool signal_and_wait(wait_handle& to_signal, wait_handle& to_wait, int32 milliseconds_timeout);
143
152 static bool signal_and_wait(wait_handle& to_signal, wait_handle& to_wait, const time_span& timeout);
153
160 template<class collection_t>
161 static bool wait_all(const collection_t& wait_handles) {return wait_all(wait_handles, timeout::infinite);}
162
171 template<class collection_t>
172 static bool wait_all(const collection_t& wait_handles, int32 milliseconds_timeout) {
173 auto wait_handle_pointers = std::vector<wait_handle*> {};
174 for (auto& item : wait_handles)
175 wait_handle_pointers.push_back(const_cast<wait_handle*>(as<wait_handle>(&item)));
176 return wait_all(array<wait_handle*> {wait_handle_pointers}, milliseconds_timeout);
177 }
178
187 template<class collection_t>
188 static bool wait_all(const collection_t& wait_handles, const time_span& timeout) {return wait_all(wait_handles, as<int32>(timeout.total_milliseconds_duration().count()));}
189
197 template<class collection_t>
198 static size_t wait_any(const collection_t& wait_handles) {return wait_any(wait_handles, timeout::infinite);}
199
208 template<class collection_t>
209 static size_t wait_any(const collection_t& wait_handles, int32 milliseconds_timeout) {
210 auto wait_handle_pointers = std::vector<wait_handle*> {};
211 for (auto& item : wait_handles)
212 wait_handle_pointers.push_back(const_cast<wait_handle*>(as<wait_handle>(&item)));
213 return wait_any(xtd::array<wait_handle*> {wait_handle_pointers}, milliseconds_timeout);
214 }
215
224 template<class collection_t>
225 static size_t wait_any(const collection_t& wait_handles, const time_span& timeout) {return wait_any(wait_handles, as<int32>(timeout.total_milliseconds_duration().count()));}
227
229 template<class ...items_t>
230 static bool wait_all(items_t... items) {return wait_all(timeout::infinite, items...);}
231 template<class ...items_t>
232 static bool wait_all(const time_span& timeout, items_t... items) {return wait_all(as<int32>(timeout.total_milliseconds()), items...);}
233 template<class ...items_t>
234 static bool wait_all(int32 milliseconds_timeout, items_t... items) {
235 auto wait_handle_pointers = std::vector<wait_handle*> {};
236 fill_wait_handle_pointers(wait_handle_pointers, items...);
237 return wait_all(xtd::array<wait_handle*> {wait_handle_pointers}, milliseconds_timeout);
238 }
239 template<class item_t>
240 static bool wait_all(const std::initializer_list<item_t>& wait_handles) {return wait_all(wait_handles, timeout::infinite);}
241 template<class item_t>
242 static bool wait_all(const std::initializer_list<item_t>& wait_handles, int32 milliseconds_timeout) {
243 auto wait_handle_pointers = std::vector<wait_handle*> {};
244 for (auto& item : wait_handles)
245 wait_handle_pointers.push_back(const_cast<wait_handle*>(as<wait_handle>(&item)));
246 return wait_all(xtd::array<wait_handle*> {wait_handle_pointers}, milliseconds_timeout);
247 }
248 template<class item_t>
249 static bool wait_all(const std::initializer_list<item_t>& wait_handles, const time_span& timeout) {return wait_all(wait_handles, as<int32>(timeout.total_milliseconds_duration().count()));}
250 static bool wait_all(const std::initializer_list<xtd::sptr<wait_handle>>& wait_handles);
251 static bool wait_all(const std::initializer_list<xtd::sptr<wait_handle>>& wait_handles, int32 milliseconds_timeout);
252 static bool wait_all(const std::initializer_list<xtd::sptr<wait_handle>>& wait_handles, const time_span& timeout);
253 static bool wait_all(const std::initializer_list<xtd::uptr<wait_handle>>& wait_handles);
254 static bool wait_all(const std::initializer_list<xtd::uptr<wait_handle>>& wait_handles, int32 milliseconds_timeout);
255 static bool wait_all(const std::initializer_list<xtd::uptr<wait_handle>>& wait_handles, const time_span& timeout);
256 static bool wait_all(const xtd::array<xtd::sptr<wait_handle>>& wait_handles);
257 static bool wait_all(const xtd::array<xtd::sptr<wait_handle>>& wait_handles, int32 milliseconds_timeout);
258 static bool wait_all(const xtd::array<xtd::sptr<wait_handle>>& wait_handles, const time_span& timeout);
259 static bool wait_all(const xtd::array<xtd::uptr<wait_handle>>& wait_handles);
260 static bool wait_all(const xtd::array<xtd::uptr<wait_handle>>& wait_handles, int32 milliseconds_timeout);
261 static bool wait_all(const xtd::array<xtd::uptr<wait_handle>>& wait_handles, const time_span& timeout);
262 static bool wait_all(const xtd::array<wait_handle*>& wait_handles, int32 milliseconds_timeout);
263
264 template<class ...items_t>
265 static size_t wait_any(items_t... items) {return wait_any(timeout::infinite, items...);}
266 template<class ...items_t>
267 static size_t wait_any(const time_span& timeout, items_t... items) {return wait_any(as<int32>(timeout.total_milliseconds()), items...);}
268 template<class ...items_t>
269 static size_t wait_any(int32 milliseconds_timeout, items_t... items) {
270 auto wait_handle_pointers = std::vector<wait_handle*> {};
271 fill_wait_handle_pointers(wait_handle_pointers, items...);
272 return wait_any(xtd::array<wait_handle*> {wait_handle_pointers}, milliseconds_timeout);
273 }
274 template<class item_t>
275 static size_t wait_any(const std::initializer_list<item_t>& wait_handles) {return wait_any(wait_handles, timeout::infinite);}
276 template<class item_t>
277 static size_t wait_any(const std::initializer_list<item_t>& wait_handles, int32 milliseconds_timeout) {
278 auto wait_handle_pointers = std::vector<wait_handle*> {};
279 for (auto& item : wait_handles)
280 wait_handle_pointers.push_back(const_cast<wait_handle*>(as<wait_handle>(&item)));
281 return wait_any(xtd::array<wait_handle*> {wait_handle_pointers}, milliseconds_timeout);
282 }
283 template<class item_t>
284 static size_t wait_any(const std::initializer_list<item_t>& wait_handles, const time_span& timeout) {return wait_any(wait_handles, as<int32>(timeout.total_milliseconds_duration().count()));}
285 static size_t wait_any(const std::initializer_list<xtd::sptr<wait_handle>>& wait_handles);
286 static size_t wait_any(const std::initializer_list<xtd::sptr<wait_handle>>& wait_handles, int32 milliseconds_timeout);
287 static size_t wait_any(const std::initializer_list<xtd::sptr<wait_handle>>& wait_handles, const time_span& timeout);
288 static size_t wait_any(const std::initializer_list<xtd::uptr<wait_handle>>& wait_handles);
289 static size_t wait_any(const std::initializer_list<xtd::uptr<wait_handle>>& wait_handles, int32 milliseconds_timeout);
290 static size_t wait_any(const std::initializer_list<xtd::uptr<wait_handle>>& wait_handles, const time_span& timeout);
291 static size_t wait_any(const xtd::array<xtd::sptr<wait_handle>>& wait_handles);
292 static size_t wait_any(const xtd::array<xtd::sptr<wait_handle>>& wait_handles, int32 milliseconds_timeout);
293 static size_t wait_any(const xtd::array<xtd::sptr<wait_handle>>& wait_handles, const time_span& timeout);
294 static size_t wait_any(const xtd::array<xtd::uptr<wait_handle>>& wait_handles);
295 static size_t wait_any(const xtd::array<xtd::uptr<wait_handle>>& wait_handles, int32 milliseconds_timeout);
296 static size_t wait_any(const xtd::array<xtd::uptr<wait_handle>>& wait_handles, const time_span& timeout);
297 static size_t wait_any(const xtd::array<wait_handle*>& wait_handles, int32 milliseconds_timeout);
299
300 protected:
302
307 virtual bool signal() = 0;
308
315 virtual bool wait(int32 milliseconds_timeout) = 0;
317
318 private:
319 template<class item_t, class ...items_t>
320 static void fill_wait_handle_pointers(std::vector<wait_handle*>& wait_handle_pointers, item_t& first, items_t& ... rest) {
321 wait_handle_pointers.push_back(const_cast<wait_handle*>(as<wait_handle>(&first)));
322 fill_wait_handle_pointers(wait_handle_pointers, rest...);
323 }
324 template<class item_t>
325 static void fill_wait_handle_pointers(std::vector<wait_handle*>& wait_handle_pointers, item_t& item) {
326 wait_handle_pointers.push_back(const_cast<wait_handle*>(as<wait_handle>(&item)));
327 }
328 };
329 }
330}
abstract.hpp
Contains xtd::abstract_object class.
as.hpp
Contains xtd::as method.
xtd::array
Provides methods for creating, manipulating, searching, and sorting arrays, thereby serving as the ba...
Definition array.hpp:61
xtd::box_integer< size_t >::max_value
static constexpr size_t max_value
Definition box_integer.hpp:67
xtd::threading::registered_wait_handle
A synchronization primitive that can also be used for interprocess synchronization.
Definition registered_wait_handle.hpp:29
xtd::threading::thread
Creates and controls a thread, sets its priority, and gets its status.
Definition thread.hpp:45
xtd::threading::timeout
Contains a constant used to specify an infinite amount of time. This class cannot be inherited.
Definition timeout.hpp:33
xtd::threading::timeout::infinite
static constexpr int32 infinite
A constant used to specify an infinite waiting period. This field is constant.
Definition timeout.hpp:41
xtd::threading::wait_handle
Encapsulates operating system specific objects that wait for exclusive access to shared resources.
Definition wait_handle.hpp:52
xtd::threading::wait_handle::signal_and_wait
static bool signal_and_wait(wait_handle &to_signal, wait_handle &to_wait)
Signals one xtd::threading::wait_handle and waits on another.
xtd::threading::wait_handle::close
virtual void close()
Releases all resources held by the current xtd::threading::wait_handle.
xtd::threading::wait_handle::invalid_handle
static const intptr invalid_handle
Represents an invalid native operating system handle. This field is read-only.
Definition wait_handle.hpp:63
xtd::threading::wait_handle::wait_all
static bool wait_all(const collection_t &wait_handles)
Waits for all the elements in the specified collection to receive a signal.
Definition wait_handle.hpp:161
xtd::threading::wait_handle::wait_any
static size_t wait_any(const collection_t &wait_handles, int32 milliseconds_timeout)
Waits for any of the elements in the specified collection to receive a signal, using a 32-bit signed ...
Definition wait_handle.hpp:209
xtd::threading::wait_handle::wait_handle
wait_handle()=default
Initializes a new instance of the xtd::threading::wait_handle class.
xtd::threading::wait_handle::wait_timeout
static constexpr size_t wait_timeout
Indicates that a xtd::threading::wait_handle::wait_any operation timed out before any of the wait han...
Definition wait_handle.hpp:67
xtd::threading::wait_handle::wait_all
static bool wait_all(const collection_t &wait_handles, int32 milliseconds_timeout)
Waits for all the elements in the specified collection to receive a signal, using an int32 value to m...
Definition wait_handle.hpp:172
xtd::threading::wait_handle::wait
virtual bool wait(int32 milliseconds_timeout)=0
wait ownership of the specified mutex object.
xtd::threading::wait_handle::wait_one
virtual bool wait_one()
Blocks the current thread until the current xtd::threading::wait_handle receives a signal.
xtd::threading::wait_handle::handle
virtual intptr handle() const noexcept=0
Gets the native operating system handle.
xtd::threading::wait_handle::signal
virtual bool signal()=0
Releases ownership of the specified wait_handle object.
xtd::threading::wait_handle::wait_all
static bool wait_all(const collection_t &wait_handles, const time_span &timeout)
Waits for all the elements in the specified collection to receive a signal, using a xtd::time_span va...
Definition wait_handle.hpp:188
xtd::threading::wait_handle::wait_any
static size_t wait_any(const collection_t &wait_handles)
Waits for any of the elements in the specified collection to receive a signal.
Definition wait_handle.hpp:198
xtd::threading::wait_handle::wait_any
static size_t wait_any(const collection_t &wait_handles, const time_span &timeout)
Waits for any of the elements in the specified collection to receive a signal, using a xtd::time_span...
Definition wait_handle.hpp:225
xtd::time_span
Represents a time interval.
Definition time_span.hpp:29
xtd::time_span::total_milliseconds
double total_milliseconds() const noexcept
Gets the value of the current xtd::time_span structure expressed in whole and fractional milliseconds...
core_export_
#define core_export_
Define shared library export.
Definition core_export.hpp:13
xtd::sptr
xtd::shared_ptr_object< type_t > sptr
The xtd::sptr object is a shared pointer.
Definition sptr.hpp:25
xtd::int32
int32_t int32
Represents a 32-bit signed integer.
Definition int32.hpp:23
xtd::uptr
xtd::unique_ptr_object< type_t > uptr
The xtd::uptr object is a unique pointer.
Definition uptr.hpp:25
xtd::intptr
intmax_t intptr
Represent a pointer or a handle.
Definition intptr.hpp:23
xtd::as
type_t as(any_object &o)
Casts a type into another type.
Definition __as_any_object.hpp:59
xtd::threading
The xtd::threading namespace provides classes and interfaces that enable multithreaded programming....
Definition abandoned_mutex_exception.hpp:10
xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8
xtd::first
read_only_span< type_t, count > first() const
Obtains a subspan consisting of the first count elements of the sequence.
Definition read_only_span.hpp:282
size_object.hpp
Contains xtd::size_object alias.
time_span.hpp
Contains xtd::time_span class.
timeout.hpp
Contains xtd::threading::timeout class.
types.hpp
Contains xtd fundamental types.
Generated on Wed Jul 2 2025 21:01:11 for xtd by Gammasoft. All rights reserved.