xtd::native::condition_variable Class Reference

Definition

Contains condition_variable native API.

Namespace

xtd::native

Library

xtd.core.native

Remarks

xtd::threading::semaphore does not use xtd::native::condition_variable API as it uses std::recursive_timed_mutex class.

Warning

Internal use only

Protected Static Methods
static intmax_t	create ()
	Create condition variable.
static void	destroy (intmax_t handle)
	Destroy condition variable with specified condition variable handle.
static void	pulse (intmax_t handle)
	Pulse wainting condition variable with specified condition variable handle.
static void	pulse_all (intmax_t handle)
	Pulse all waiting condition variable with specified condition variable handle.
static bool	wait (intmax_t handle, intmax_t critical_section_handle, int32_t milliseconds_timeout)
	Wait`condition variable with specified condition variable handle.

Member Function Documentation

create()

static intmax_t xtd::native::condition_variable::create ( )

staticprotected

Create condition variable.

Returns

The handle of the created condition variable.

Warning

Internal use only

destroy()

static void xtd::native::condition_variable::destroy ( intmax_t  handle )

staticprotected

Destroy condition variable with specified condition variable handle.

Parameters

handle

The condition variable handle to destroy.

Warning

Internal use only

pulse()

static void xtd::native::condition_variable::pulse ( intmax_t  handle )

staticprotected

Pulse wainting condition variable with specified condition variable handle.

Parameters

handle

The condition variable handle to pulse.

Returns

true if succeed; otherwhise false.

pulse_all()

static void xtd::native::condition_variable::pulse_all ( intmax_t  handle )

staticprotected

Pulse all waiting condition variable with specified condition variable handle.

Parameters

handle

The condition variable handle to pulse all.

Returns

true if succeed; otherwhise false.

wait()

static bool xtd::native::condition_variable::wait ( intmax_t  handle, intmax_t  critical_section_handle, int32_t  milliseconds_timeout  )

staticprotected

Wait`condition variable with specified condition variable handle.

Parameters

handle	The condition variable handle to release.
critical_section_handle	The critical section handle associate to the condition variable handle.
milliseconds_timeout	The timeout in milliseconds (-1 is infinite timeout).

Returns

true if succeed; otherwhise false.

Warning

Internal use only

---

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

• xtd.core.native/include/xtd/native/condition_variable.hpp