Mutex implemnetation. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include <mutex.h>

Inherits System::Threading::WaitHandle.

Public Member Functions
	Mutex ()
	Constructs unowned mutex. More...

	Mutex (bool initiallyOwned)
	Constructor. More...

	Mutex (bool initiallyOwned, const String &name)
	Constructor. More...

void	ReleaseMutex ()
	Releases the mutex. More...

virtual bool	Reset ()
	Resets mutex state. Not implemented. More...

virtual bool	Set ()
	Set mutex to signalled state. Not implemented. More...

virtual bool	WaitOne () override
	Locks mutex. Performs unlimited waiting if neccessary. More...

virtual bool	WaitOne (int millisecondsTimeout) override
	Locks mutex. Performs waiting if neccessary. More...

virtual bool	WaitOne (TimeSpan timeout) override
	Locks mutex. Performs waiting if neccessary. More...

Public Member Functions inherited from System::Threading::WaitHandle
virtual bool	WaitOne ()
	Waits for the handle to fire for unlimited period. More...

virtual bool	WaitOne (int millisecondsTimeout)
	Waits for the handle to fire. More...

virtual bool	WaitOne (TimeSpan timeout)
	Waits for the handle to fire. More...

virtual bool	WaitOne (int millisecondsTimeout, bool exitContext)
	Waits for the handle to fire. More...

virtual	~WaitHandle ()
	Destructor. More...

virtual void	Close ()
	Releases any resource associated with handle. More...

wait_handle_t	get_Handle ()
	Gets handle. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Static Public Member Functions
static bool	Remove (const String &mutexName)
	Erases a named mutex from the system. More...

Static Public Member Functions inherited from System::Threading::WaitHandle
static bool	WaitAll (const System::ArrayPtr< System::SharedPtr< WaitHandle > > &waitHandles, int millisecondsTimeout)
	Waits for all handles to fire. More...

static bool	WaitAll (const System::ArrayPtr< System::SharedPtr< WaitHandle > > &waitHandles, TimeSpan timeout)
	Waits for all handles to fire. More...

static bool	WaitAll (const System::ArrayPtr< System::SharedPtr< WaitHandle > > &waitHandles)
	Waits for all handles to fire. More...

static int	WaitAny (const System::ArrayPtr< System::SharedPtr< WaitHandle > > &waitHandles, int millisecondsTimeout)
	Waits for any of the handles to fire. More...

static int	WaitAny (const System::ArrayPtr< System::SharedPtr< WaitHandle > > &waitHandles, TimeSpan timeout)
	Waits for any of the handles to fire. More...

static int	WaitAny (const System::ArrayPtr< System::SharedPtr< WaitHandle > > &waitHandles)
	Waits for any of the handles to fire. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Static Public Attributes inherited from System::Threading::WaitHandle
static const int	WaitTimeout = 0x102
	Special value to be returned by the function otherwise returning index of signalled object in array, if timeout exceeds and nothing signals. More...

Protected Member Functions inherited from System::Threading::WaitHandle
	WaitHandle (wait_handle_t handle)
	Constructor. More...

Static Protected Member Functions inherited from System::Threading::WaitHandle
static int	WaitMultiple (const System::ArrayPtr< System::SharedPtr< WaitHandle > > &waitHandles, int millisecondsTimeout, bool waitAll, int &index)
	Implementation of waiting for multiple objects. More...

static void	CheckIsValidTimeout (TimeSpan timeout)
	Checks that the timeout parameter is not greater than the INT32_MAX value. More...

Detailed Description

Mutex implemnetation. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

#include "system/threading/mutex.h"
#include "system/threading/thread.h"
#include "system/console.h"
#include "system/convert.h"
#include "system/smart_ptr.h"
#include "system/string.h"
 
int main()
{
  auto mutex = System::MakeObject<System::Threading::Mutex>();
 
  System::String str;
 
  const int THREADS_COUNT = 3;
  std::vector<System::SharedPtr<System::Threading::Thread>> threads;
  threads.reserve(THREADS_COUNT);
 
  for (auto i = 0; i < THREADS_COUNT; ++i)
  {
    threads.push_back(System::MakeObject<System::Threading::Thread>([&mutex, &str]()
    {
      mutex->WaitOne();
 
      str += u"Thread " + System::Convert::ToString(System::Threading::Thread::GetCurrentThreadId()) + u" started." + System::Environment::get_NewLine();
 
      System::Threading::Thread::Sleep(200);
 
      str += u"Thread " + System::Convert::ToString(System::Threading::Thread::GetCurrentThreadId()) + u" ended." + System::Environment::get_NewLine();
 
      mutex->ReleaseMutex();
    }));
 
    threads[i]->Start();
  }
 
  System::Threading::Thread::Sleep(700);
 
  System::Console::WriteLine(str);
 
  return 0;
}
/*
This code example produces the following output:
Thread 1 started.
Thread 1 ended.
Thread 2 started.
Thread 2 ended.
Thread 3 started.
Thread 3 ended.
*/

Constructor & Destructor Documentation

◆ Mutex() [1/3]

System::Threading::Mutex::Mutex ( )

Constructs unowned mutex.

◆ Mutex() [2/3]

System::Threading::Mutex::Mutex ( bool initiallyOwned )

Constructor.

Parameters

initiallyOwned If true, the mutex being constructed is owned initially.

◆ Mutex() [3/3]

System::Threading::Mutex::Mutex	(	bool	initiallyOwned,
		const String &	name
	)

Constructor.

Parameters

initiallyOwned	If true, the mutex being constructed is owned initially.
name	Name of the mutex.

Member Function Documentation

◆ ReleaseMutex()

void System::Threading::Mutex::ReleaseMutex ( )

Releases the mutex.

◆ Remove()

static bool System::Threading::Mutex::Remove ( const String & mutexName )

static

Erases a named mutex from the system.

Returns: false on error

◆ Reset()

virtual bool System::Threading::Mutex::Reset ( )

virtual

Resets mutex state. Not implemented.

◆ Set()

virtual bool System::Threading::Mutex::Set ( )

virtual

Set mutex to signalled state. Not implemented.

◆ WaitOne() [1/3]

virtual bool System::Threading::Mutex::WaitOne ( )

overridevirtual

Locks mutex. Performs unlimited waiting if neccessary.

Returns: Always returns true as it does not return until mutex is locked.

Reimplemented from System::Threading::WaitHandle.

◆ WaitOne() [2/3]

virtual bool System::Threading::Mutex::WaitOne ( int millisecondsTimeout )

overridevirtual

Locks mutex. Performs waiting if neccessary.

Parameters

millisecondsTimeout Waiting timeout in milliseconds.

Returns: Returns true if mutex was locked or false if timeout exceeded.

Reimplemented from System::Threading::WaitHandle.

◆ WaitOne() [3/3]

virtual bool System::Threading::Mutex::WaitOne ( TimeSpan timeout )

overridevirtual

Locks mutex. Performs waiting if neccessary.

Parameters

timeout A System::TimeSpan that represents the number of milliseconds to wait, or a System::TimeSpan that represents -1 milliseconds to wait indefinitely.

Returns: Returns true if mutex was locked or false if timeout exceeded.

Reimplemented from System::Threading::WaitHandle.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Mutex() [1/3]

◆ Mutex() [2/3]

◆ Mutex() [3/3]

Member Function Documentation

◆ ReleaseMutex()

◆ Remove()

◆ Reset()

◆ Set()

◆ WaitOne() [1/3]

◆ WaitOne() [2/3]

◆ WaitOne() [3/3]