WaitHandle
Contents
[
Hide
]WaitHandle class
Waiting primitive base class. 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 WaitHandle : public System::Object
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. |
| 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. |
| int RemovedSharedRefs(int) | Decreases shared reference count by specified value. |
| 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. |
| virtual bool WaitOne() | Waits for the handle to fire for unlimited period. |
| virtual bool WaitOne(int) | Waits for the handle to fire. |
| virtual bool WaitOne(TimeSpan) | Waits for the handle to fire. |
| 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. |
See Also
- Class Object
- Namespace System::Threading
- Library Aspose.Slides