xtd::threading::registered_wait_handle Class Reference

Inheritance diagram for xtd::threading::registered_wait_handle:

Definition

A synchronization primitive that can also be used for interprocess synchronization.

class core_export_ registered_wait_handle final : public xtd::object

Header

#include <xtd/threading/registered_wait_handle>

Namespace

xtd::threading

Library

xtd.core

Public Methods
bool	unregister ()
	Cancels a registered wait operation issued by the xtd::threading::thread_pool::register_wait_for_single_object method.
bool	unregister (wait_handle &wait_obbject)
	Cancels a registered wait operation issued by the xtd::threading::thread_pool::register_wait_for_single_object method.

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.
Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<typename object_a_t , typename object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Member Function Documentation

unregister() [1/2]

bool xtd::threading::registered_wait_handle::unregister

(

)

Cancels a registered wait operation issued by the xtd::threading::thread_pool::register_wait_for_single_object method.

Returns

bool true if the function succeeds; otherwise, false

Remarks

If wait_object is specified, it is signaled only if the xtd::threading::registered_wait_handle is successfully unregistered. If a callback method is in progress when Unregister executes, wait_object is not signaled until the callback method completes. In particular, if a callback method executes Unregister, waitObject is not signaled until that callback method completes.

See also

xtd::threading::thread_pool

unregister() [2/2]

bool xtd::threading::registered_wait_handle::unregister

(

wait_handle &

wait_obbject

)

Cancels a registered wait operation issued by the xtd::threading::thread_pool::register_wait_for_single_object method.

Parameters

wait_object

The xtd::threading::wait_handle to be signaled.

Returns

bool true if the function succeeds; otherwise, false

Remarks

If wait_object is specified, it is signaled only if the xtd::threading::registered_wait_handle is successfully unregistered. If a callback method is in progress when Unregister executes, wait_object is not signaled until the callback method completes. In particular, if a callback method executes Unregister, waitObject is not signaled until that callback method completes.

See also

xtd::threading::thread_pool

---

The documentation for this class was generated from the following file:

• xtd.core/include/xtd/threading/registered_wait_handle.h