Class Monitor provides a mechanism that synchronizes access to objects. More...

#include <monitor.h>

Static Public Member Functions
static void	Enter (const SharedPtr< Object > &obj)
	Acquires an exclusive lock on a specified object. More...

static void	Enter (const System::SharedPtr< Object > &obj, bool &lockTaken)
	Acquires an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken. More...

static void	Exit (const SharedPtr< Object > &obj)
	Releases an exclusive lock on the specified object. More...

static bool	TryEnter (const SharedPtr< Object > &obj)
	Attempts to acquire an exclusive lock on the specified object Not implemented. More...

static void	TryEnter (const System::SharedPtr< Object > &obj, bool &lockTaken)
	Attempts to acquire an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken. More...

static bool	TryEnter (const SharedPtr< Object > &obj, int32_t millisecondsTimeout)
	Attempts, for the specified number of milliseconds, to acquire an exclusive lock on the specified object Not implemented. More...

static bool	TryEnter (const SharedPtr< Object > &obj, TimeSpan timeout)
	Attempts, for the specified amount of time, to acquire an exclusive lock on the specified object Not implemented. More...

static void	TryEnter (const System::SharedPtr< Object > &obj, int32_t millisecondsTimeout, bool &lockTaken)
	Attempts, for the specified amount of time, to acquire an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken. More...

static void	TryEnter (const System::SharedPtr< Object > &obj, TimeSpan timeout, bool &lockTaken)
	Attempts, for the specified amount of time, to acquire an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken. More...

static bool	IsEntered (const System::SharedPtr< Object > &obj)
	Determines whether the current thread holds the lock on the specified object. More...

static bool	Wait (const SharedPtr< Object > &obj, int32_t millisecondsTimeout, bool exitContext)
	Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. Optionally exits the synchronization domain for the synchronized context before the wait and reacquires the domain afterward. Not implemented. More...

static bool	Wait (const SharedPtr< Object > &obj, TimeSpan timeout, bool exitContext)
	Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. Optionally exits the synchronization domain for the synchronized context before the wait and reacquires the domain afterward. Not implemented. More...

static bool	Wait (const SharedPtr< Object > &obj, int32_t millisecondsTimeout)
	Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. Not implemented. More...

static bool	Wait (const SharedPtr< Object > &obj, TimeSpan timeout)
	Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. Not implemented. More...

static bool	Wait (const SharedPtr< Object > &obj)
	Releases the lock on an object and blocks the current thread until it reacquires the lock Not implemented. More...

static void	Pulse (const SharedPtr< Object > &obj)
	Notifies a thread in the waiting queue of a change in the locked object's state Not implemented. More...

static void	PulseAll (const SharedPtr< Object > &obj)
	Notifies all waiting threads of a change in the object's state Not implemented. 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...

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

Detailed Description

Class Monitor provides a mechanism that synchronizes access to objects.

#include "system/threading/monitor.h"
#include "system/threading/thread.h"
#include "system/smart_ptr.h"
#include "system/string.h"
#include <iostream>
#include <vector>
 
int main()
{
  using namespace System::Threading;
 
  const auto threadsCount = 3;
  std::cout << "Threads count: " << threadsCount << std::endl;
  auto locker = System::MakeObject<System::Object>();
  int x = 0;
 
  std::vector<System::SharedPtr<Thread>> threads;
  threads.reserve(threadsCount);
  for (auto i = 0; i < threadsCount; ++i)
  {
    threads.emplace_back(System::MakeObject<Thread>([&x, &locker]() -> void {
      Monitor::Enter(locker);
 
      x = 1;
      for (auto i = 0; i < 5; ++i)
      {
        std::cout << Thread::get_CurrentThread()->get_Name() << ": " << x++ << std::endl;
        Thread::Sleep(100);
      }
 
      Monitor::Exit(locker);
    }));
    threads.back()->set_Name(System::String("Thread " + std::to_string(i)));
    threads.back()->Start();
  }
 
  Thread::Sleep(threadsCount * 100);
 
  for (auto& thread : threads)
  {
    thread->Join();
  }
 
  return 0;
}
/*
This code example produces the following output:
Threads count: 3
Thread 0: 1
Thread 0: 2
Thread 0: 3
Thread 0: 4
Thread 0: 5
Thread 1: 1
Thread 1: 2
Thread 1: 3
Thread 1: 4
Thread 1: 5
Thread 2: 1
Thread 2: 2
Thread 2: 3
Thread 2: 4
Thread 2: 5
*/

Member Function Documentation

◆ Enter() [1/2]

static void System::Threading::Monitor::Enter ( const SharedPtr< Object > & obj )

static

Acquires an exclusive lock on a specified object.

Parameters

obj	The object on which to acquire the monitor lock.

Exceptions

ArgumentNullException The obj parameter is null.

◆ Enter() [2/2]

static void System::Threading::Monitor::Enter	(	const System::SharedPtr< Object > &	obj,
		bool &	lockTaken
	)

static

Acquires an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken.

◆ Exit()

static void System::Threading::Monitor::Exit ( const SharedPtr< Object > & obj )

static

Releases an exclusive lock on the specified object.

Parameters

obj	The object on which to release the lock.

Exceptions

ArgumentNullException	The obj parameter is null.
SynchronizationLockException	The current thread does not own the lock for the specified object.

◆ IsEntered()

static bool System::Threading::Monitor::IsEntered ( const System::SharedPtr< Object > & obj )

static

Determines whether the current thread holds the lock on the specified object.

◆ Pulse()

static void System::Threading::Monitor::Pulse ( const SharedPtr< Object > & obj )

static

Notifies a thread in the waiting queue of a change in the locked object's state Not implemented.

Exceptions

NotImplementedException Always.

◆ PulseAll()

static void System::Threading::Monitor::PulseAll ( const SharedPtr< Object > & obj )

static

Notifies all waiting threads of a change in the object's state Not implemented.

Exceptions

NotImplementedException Always.

◆ TryEnter() [1/6]

static bool System::Threading::Monitor::TryEnter ( const SharedPtr< Object > & obj )

static

Attempts to acquire an exclusive lock on the specified object Not implemented.

Exceptions

NotImplementedException Always.

◆ TryEnter() [2/6]

static bool System::Threading::Monitor::TryEnter	(	const SharedPtr< Object > &	obj,
		int32_t	millisecondsTimeout
	)

static

Attempts, for the specified number of milliseconds, to acquire an exclusive lock on the specified object Not implemented.

Exceptions

NotImplementedException Always.

◆ TryEnter() [3/6]

static bool System::Threading::Monitor::TryEnter	(	const SharedPtr< Object > &	obj,
		TimeSpan	timeout
	)

static

Attempts, for the specified amount of time, to acquire an exclusive lock on the specified object Not implemented.

Exceptions

NotImplementedException Always.

◆ TryEnter() [4/6]

static void System::Threading::Monitor::TryEnter	(	const System::SharedPtr< Object > &	obj,
		bool &	lockTaken
	)

static

Attempts to acquire an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken.

◆ TryEnter() [5/6]

static void System::Threading::Monitor::TryEnter	(	const System::SharedPtr< Object > &	obj,
		int32_t	millisecondsTimeout,
		bool &	lockTaken
	)

static

Attempts, for the specified amount of time, to acquire an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken.

◆ TryEnter() [6/6]

static void System::Threading::Monitor::TryEnter	(	const System::SharedPtr< Object > &	obj,
		TimeSpan	timeout,
		bool &	lockTaken
	)

static

Attempts, for the specified amount of time, to acquire an exclusive lock on the specified object, and atomically sets a value that indicates whether the lock was taken.

◆ Wait() [1/5]

static bool System::Threading::Monitor::Wait ( const SharedPtr< Object > & obj )

static

Releases the lock on an object and blocks the current thread until it reacquires the lock Not implemented.

Exceptions

NotImplementedException Always.

◆ Wait() [2/5]

static bool System::Threading::Monitor::Wait	(	const SharedPtr< Object > &	obj,
		int32_t	millisecondsTimeout
	)

static

Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. Not implemented.

Exceptions

NotImplementedException Always.

◆ Wait() [3/5]

static bool System::Threading::Monitor::Wait	(	const SharedPtr< Object > &	obj,
		int32_t	millisecondsTimeout,
		bool	exitContext
	)

static

Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. Optionally exits the synchronization domain for the synchronized context before the wait and reacquires the domain afterward. Not implemented.

Exceptions

NotImplementedException Always.

◆ Wait() [4/5]

static bool System::Threading::Monitor::Wait	(	const SharedPtr< Object > &	obj,
		TimeSpan	timeout
	)

static

Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. Not implemented.

Exceptions

NotImplementedException Always.

◆ Wait() [5/5]

static bool System::Threading::Monitor::Wait	(	const SharedPtr< Object > &	obj,
		TimeSpan	timeout,
		bool	exitContext
	)

static

Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. Optionally exits the synchronization domain for the synchronized context before the wait and reacquires the domain afterward. Not implemented.

Exceptions

NotImplementedException Always.

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Enter() [1/2]

◆ Enter() [2/2]

◆ Exit()

◆ IsEntered()

◆ Pulse()

◆ PulseAll()

◆ TryEnter() [1/6]

◆ TryEnter() [2/6]

◆ TryEnter() [3/6]

◆ TryEnter() [4/6]

◆ TryEnter() [5/6]

◆ TryEnter() [6/6]

◆ Wait() [1/5]

◆ Wait() [2/5]

◆ Wait() [3/5]

◆ Wait() [4/5]

◆ Wait() [5/5]