xtd::native::named_mutex Class Reference

Definition

Contains named_mutex native API.

Namespace

xtd::native

Library

xtd.core.native

Warning

Internal use only

Protected Static Methods
static intmax_t	create (bool initially_owned, const std::string &name)
	Create named mutex with specified name and a bool value that.
static void	destroy (intmax_t handle, const std::string &name)
	Destroy named mutex with specified mutex handle.
static size_t	max_name_size ()
	Gets the maximum name size supported.
static intmax_t	open (const std::string &name)
	Open named mutex with specified name.
static bool	signal (intmax_t handle, bool &io_error)
	Signal named mutex with specified mutex handle.
static uint32_t	wait (intmax_t handle, int32_t milliseconds_timeout)
	Wait named mutex with specified mutex handle and timeout.

Member Function Documentation

create()

static intmax_t xtd::native::named_mutex::create ( bool  initially_owned, const std::string &  name  )

staticprotected

Create named mutex with specified name and a bool value that.

Parameters

initially_owned	true to give the calling thread initial ownership of the named system mutex if the named system mutex is created as a result of this call; otherwise, false.
name	The name, if the synchronization object is to be shared with other processes.

Returns

The handle of the created mutex.

Warning

Internal use only

destroy()

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

staticprotected

Destroy named mutex with specified mutex handle.

Parameters

name	The name of the mutex.
handle	The mutex handle to destroy.

Warning

Internal use only

max_name_size()

static size_t xtd::native::named_mutex::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_mutex::open ( const std::string &  name )

staticprotected

Open named mutex with specified name.

Parameters

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

Returns

The handle of the opened mutex.

Warning

Internal use only

signal()

static bool xtd::native::named_mutex::signal ( intmax_t  handle, bool &  io_error  )

staticprotected

Signal named mutex with specified mutex handle.

Parameters

handle

The mutex handle to signal.

Returns

true if succeed; otherwhise false.

Warning

Internal use only

wait()

static uint32_t xtd::native::named_mutex::wait ( intmax_t  handle, int32_t  milliseconds_timeout  )

staticprotected

Wait named mutex with specified mutex handle and timeout.

Parameters

handle	The mutex handle to wait.
milliseconds_timeout	The timeout in milliseconds (-1 is infinite timeout).

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_mutex.h