Asposecpplib
System::Threading::Mutex Class Reference

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

Inherits System::Threading::WaitHandle.

Public Member Functions

ASPOSECPP_SHARED_API Mutex ()
 Constructs unowned mutex. More...
 
ASPOSECPP_SHARED_API Mutex (bool initiallyOwned)
 Constructor. More...
 
ASPOSECPP_SHARED_API Mutex (bool initiallyOwned, String name)
 Constructor. More...
 
ASPOSECPP_SHARED_API void ReleaseMutex ()
 Releases the mutex. More...
 
virtual ASPOSECPP_SHARED_API bool Reset ()
 Resets mutex state. Not implemented. More...
 
virtual ASPOSECPP_SHARED_API bool Set ()
 Set mutex to signalled state. Not implemented. More...
 
virtual ASPOSECPP_SHARED_API bool WaitOne () override
 Locks mutex. Performs unlimited waiting if neccessary. More...
 
virtual ASPOSECPP_SHARED_API bool WaitOne (int millisecondsTimeout) override
 Locks mutex. Performs waiting if neccessary. More...
 
virtual ASPOSECPP_SHARED_API bool WaitOne (TimeSpan timeout) override
 Locks mutex. Performs waiting if neccessary. More...
 
- Public Member Functions inherited from System::Threading::WaitHandle
virtual ASPOSECPP_SHARED_API bool WaitOne (int millisecondsTimeout, bool exitContext)
 Waits for the handle to fire. More...
 
virtual ASPOSECPP_SHARED_API ~WaitHandle ()
 Destructor. More...
 
virtual ASPOSECPP_SHARED_API void Close ()
 Releases any resource associated with handle. More...
 
ASPOSECPP_SHARED_API wait_handle_t get_Handle ()
 Gets handle. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API bool Remove (const String &mutexName)
 Erases a named mutex from the system. More...
 
- Static Public Member Functions inherited from System::Threading::WaitHandle
static ASPOSECPP_SHARED_API bool WaitAll (const System::ArrayPtr< System::SharedPtr< WaitHandle >> &waitHandles, int millisecondsTimeout)
 Waits for all handles to fire. More...
 
static ASPOSECPP_SHARED_API bool WaitAll (const System::ArrayPtr< System::SharedPtr< WaitHandle >> &waitHandles, TimeSpan timeout)
 Waits for all handles to fire. More...
 
static ASPOSECPP_SHARED_API bool WaitAll (const System::ArrayPtr< System::SharedPtr< WaitHandle >> &waitHandles)
 Waits for all handles to fire. More...
 
static ASPOSECPP_SHARED_API int WaitAny (const System::ArrayPtr< System::SharedPtr< WaitHandle >> &waitHandles, int millisecondsTimeout)
 Waits for any of the handles to fire. More...
 
static ASPOSECPP_SHARED_API int WaitAny (const System::ArrayPtr< System::SharedPtr< WaitHandle >> &waitHandles, TimeSpan timeout)
 Waits for any of the handles to fire. More...
 
static ASPOSECPP_SHARED_API 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 TypeInfoType ()
 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< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Attributes inherited from System::Threading::WaitHandle
static ASPOSECPP_SHARED_API 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
ASPOSECPP_SHARED_API WaitHandle (wait_handle_t handle)
 Constructor. More...
 
- Static Protected Member Functions inherited from System::Threading::WaitHandle
static ASPOSECPP_SHARED_API int WaitMultiple (const System::ArrayPtr< System::SharedPtr< WaitHandle >> &waitHandles, int millisecondsTimeout, bool waitAll, int &index)
 Implementation of waiting for multiple objects. More...
 
static ASPOSECPP_SHARED_API 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.

Constructor & Destructor Documentation

◆ Mutex() [1/3]

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

Constructs unowned mutex.

◆ Mutex() [2/3]

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

Constructor.

Parameters
initiallyOwnedIf true, the mutex being constructed is owned initially.

◆ Mutex() [3/3]

ASPOSECPP_SHARED_API System::Threading::Mutex::Mutex ( bool  initiallyOwned,
String  name 
)

Constructor.

Parameters
initiallyOwnedIf true, the mutex being constructed is owned initially.
nameName of the mutex.

Member Function Documentation

◆ ReleaseMutex()

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

Releases the mutex.

◆ Remove()

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

Erases a named mutex from the system.

Returns
false on error

◆ Reset()

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

Resets mutex state. Not implemented.

◆ Set()

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

Set mutex to signalled state. Not implemented.

◆ WaitOne() [1/3]

virtual ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API bool System::Threading::Mutex::WaitOne ( int  millisecondsTimeout)
overridevirtual

Locks mutex. Performs waiting if neccessary.

Parameters
millisecondsTimeoutWaiting timeout in milliseconds.
Returns
Returns true if mutex was locked or false if timeout exceeded.

Reimplemented from System::Threading::WaitHandle.

◆ WaitOne() [3/3]

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

Locks mutex. Performs waiting if neccessary.

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