xtd::native::named_event_wait_handle Class Reference

Definition

Contains named_event_wait_handle native API.

Namespace

xtd::native

Library

xtd.core.native

Warning

Internal use only

Protected Static Methods
static intmax_t	create (bool initial_state, bool manual_reset, const std::string &name)
	Create named event wait handle with specified name, initial count and maxixum count.
static void	destroy (intmax_t handle, const std::string &name)
	Destroy named event wait handle with specified event wait handle handle.
static size_t	max_name_size ()
	Gets the maximum name size supported.
static intmax_t	open (const std::string &name)
	Open named event wait handle with specified name.
static bool	set (intmax_t handle, bool &io_error)
	Sets the state of the event to signaled, allowing one or more waiting threads to proceed.
static bool	reset (intmax_t handle, bool &io_error)
	Sets the state of the event to nonsignaled, causing threads to block.
static uint32_t	wait (intmax_t handle, int32_t milliseconds_timeout, bool manual_reset)
	Wait named event wait handle with specified event wait handle handle, timeout and manual reset.

Member Function Documentation

create()

static intmax_t xtd::native::named_event_wait_handle::create ( bool  initial_state, bool  manual_reset, const std::string &  name  )

staticprotected

Create named event wait handle with specified name, initial count and maxixum count.

Parameters

initial_state	true to set the initial state to signaled if the named event is created as a result of this call; false to set it to nonsignaled.
manual_reset	true the event resets manually; false the event resets automatically.
name	The name, if the synchronization object is to be shared with other processes.

Returns

The handle of the created event wait handle.

Warning

Internal use only

destroy()

static void xtd::native::named_event_wait_handle::destroy ( intmax_t  handle, const std::string &  name  )

staticprotected

Destroy named event wait handle with specified event wait handle handle.

Parameters

name	The name of the event wait handle.
handle	The event wait handle handle to destroy.

Warning

Internal use only

max_name_size()

static size_t xtd::native::named_event_wait_handle::max_name_size ( )

staticprotected

Gets the maximum name size supported.

Returns

The maximum name size supported.

Warning

Internal use only

open()

static intmax_t xtd::native::named_event_wait_handle::open ( const std::string &  name )

staticprotected

Open named event wait handle with specified name.

Parameters

name	The name, if the synchronization object is to be shared with other processes.

Returns

The handle of the opened event wait handle.

Warning

Internal use only

set()

static bool xtd::native::named_event_wait_handle::set ( intmax_t  handle, bool &  io_error  )

staticprotected

Sets the state of the event to signaled, allowing one or more waiting threads to proceed.

Parameters

handle

The event wait handle handle to set.

Returns

true if succeed; otherwhise false.

Warning

Internal use only

reset()

static bool xtd::native::named_event_wait_handle::reset ( intmax_t  handle, bool &  io_error  )

staticprotected

Sets the state of the event to nonsignaled, causing threads to block.

Parameters

handle

The event wait handle handle to reset.

Returns

true if succeed; otherwhise false.

Warning

Internal use only

wait()

static uint32_t xtd::native::named_event_wait_handle::wait ( intmax_t  handle, int32_t  milliseconds_timeout, bool  manual_reset  )

staticprotected

Wait named event wait handle with specified event wait handle handle, timeout and manual reset.

Parameters

handle	The event wait handle handle to wait.
milliseconds_timeout	The timeout in milliseconds (-1 is infinite timeout).
manual_reset	true the event resets manually; false the event resets automatically.

Returns

error code :

• 0x00000000 : Sucess
• 0x00000080 : Abandoned
• 0x00000102 : Timeout
• 0xFFFFFFFF : Failed

Warning

Internal use only

---

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

• xtd.core.native/include/xtd/native/named_event_wait_handle.h