Mutex
Contents
[
Hide
]Mutex class
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.
class Mutex : public System::Threading::WaitHandle
Methods
Method | Description |
---|---|
virtual void Close() | Releases any resource associated with handle. |
virtual bool Equals(ptr) | Compares objects using C# Object.Equals semantics. |
static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&) | Compares reference type objects in C# style. |
static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&) | Compares value type objects in C# style. |
static bool Equals(float const&, float const&) | 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. |
static bool Equals(double const&, double const&) | 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. |
virtual bool FastCast(const Details::FastRttiBase&, void **) const | For internal purposes only. |
wait_handle_t get_Handle() | Gets handle. |
Detail::SmartPtrCounter * GetCounter() | Gets reference counter data structure associated with the object. |
virtual int32_t GetHashCode() const | Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. |
virtual const TypeInfo& GetType() const | Gets actual type of object. Analog of C# System.Object.GetType() call. |
virtual bool Is(const TypeInfo&) const | Check if object represents an instance of type described by targetType. Analog of C# ‘is’ operator. |
void Lock() | Implements C# lock() statement locking. Call directly or use LockContext sentry object. |
virtual ptr MemberwiseClone() const | Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. |
Mutex() | Constructs unowned mutex. |
Mutex(bool) | Constructor. |
Mutex(bool, const String&) | Constructor. |
Object() | Creates object. Initializes all internal data structures. |
Object(Object const&) | Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses. |
Object& operator=(Object const&) | Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses. |
static bool ReferenceEquals(ptr const&, ptr const&) | Compares objects by reference. |
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&) | Compares objects by reference. |
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t) | Reference-compares value type object with nullptr. |
bool ReferenceEquals(String const&, std::nullptr_t) | Specialization of Object::ReferenceEquals for case of string and nullptr. |
bool ReferenceEquals(String const&, String const&) | Specialization of Object::ReferenceEquals for case of strings. |
void ReleaseMutex() | Releases the mutex. |
static bool Remove(const String&) | Erases a named mutex from the system. |
int RemovedSharedRefs(int) | Decreases shared reference count by specified value. |
virtual bool Reset() | Resets mutex state. Not implemented. |
virtual bool Set() | Set mutex to signalled state. Not implemented. |
virtual void SetTemplateWeakPtr(uint32_t) | Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. |
int SharedCount() const | Gets current value of shared reference counter. |
Object * SharedRefAdded() | Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
int SharedRefRemovedSafe() | Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
virtual String ToString() const | Analog of C# Object.ToString() method. Enables converting custom objects to string. |
static const TypeInfo& Type() | Implements C# typeof(System.Object) construct. |
void Unlock() | Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. |
static bool WaitAll(const System::ArrayPtr<System::SharedPtr<WaitHandle>>&, int) | Waits for all handles to fire. |
static bool WaitAll(const System::ArrayPtr<System::SharedPtr<WaitHandle>>&, TimeSpan) | Waits for all handles to fire. |
static bool WaitAll(const System::ArrayPtr<System::SharedPtr<WaitHandle>>&) | Waits for all handles to fire. |
static int WaitAny(const System::ArrayPtr<System::SharedPtr<WaitHandle>>&, int) | Waits for any of the handles to fire. |
static int WaitAny(const System::ArrayPtr<System::SharedPtr<WaitHandle>>&, TimeSpan) | Waits for any of the handles to fire. |
static int WaitAny(const System::ArrayPtr<System::SharedPtr<WaitHandle>>&) | Waits for any of the handles to fire. |
bool WaitOne() override | Locks mutex. Performs unlimited waiting if neccessary. |
bool WaitOne(int) override | Locks mutex. Performs waiting if neccessary. |
bool WaitOne(TimeSpan) override | Locks mutex. Performs waiting if neccessary. |
virtual bool WaitOne(int, bool) | Waits for the handle to fire. |
Detail::SmartPtrCounter * WeakRefAdded() | Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
void WeakRefRemoved() | Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector. |
virtual ~Object() | Destroys object. Frees all internal data structures. |
virtual ~WaitHandle() | Destructor. |
Fields
Field | Description |
---|---|
static WaitTimeout | Special value to be returned by the function otherwise returning index of signalled object in array, if timeout exceeds and nothing signals. |
Remarks
#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.
*/
See Also
- Class WaitHandle
- Namespace System::Threading
- Library Aspose.Slides