Asposecpplib

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

Inherits System::Object.

Inherited by System::Threading::EventWaitHandle, System::Threading::Mutex, and System::Threading::Semaphore.

Public Member Functions

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...
 
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...
 
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 TypeInfoGetType () 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 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 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...
 

Static Public Attributes

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

 WaitHandle (wait_handle_t handle)
 Constructor. More...
 

Static Protected Member Functions

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

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ~WaitHandle()

virtual System::Threading::WaitHandle::~WaitHandle ( )
virtual

Destructor.

◆ WaitHandle()

System::Threading::WaitHandle::WaitHandle ( wait_handle_t  handle)
protected

Constructor.

Parameters
handleRaw handle value.

Member Function Documentation

◆ CheckIsValidTimeout()

static void System::Threading::WaitHandle::CheckIsValidTimeout ( TimeSpan  timeout)
staticprotected

Checks that the timeout parameter is not greater than the INT32_MAX value.

Parameters
timeoutA TimeSpan class instance to ckeck.
Exceptions
ArgumentOutOfRangeExceptionIf a passed value is greater than the INT32_MAX value.

◆ Close()

virtual void System::Threading::WaitHandle::Close ( )
virtual

Releases any resource associated with handle.

◆ get_Handle()

wait_handle_t System::Threading::WaitHandle::get_Handle ( )

Gets handle.

Returns
Raw handle owned by object.

◆ WaitAll() [1/3]

static bool System::Threading::WaitHandle::WaitAll ( const System::ArrayPtr< System::SharedPtr< WaitHandle >> &  waitHandles)
static

Waits for all handles to fire.

Parameters
waitHandlesHandles to wait for.
Returns
True when every element in waitHandles has received a signal; otherwise the method never returns.

◆ WaitAll() [2/3]

static bool System::Threading::WaitHandle::WaitAll ( const System::ArrayPtr< System::SharedPtr< WaitHandle >> &  waitHandles,
int  millisecondsTimeout 
)
static

Waits for all handles to fire.

Parameters
waitHandlesHandles to wait for.
millisecondsTimeoutTimeout to wait for, in milliseconds; -1 means infinite waiting, 0 means check-and-return, positive values are timeouts.
Returns
True if all handles fired, false if timeout exceeded.

◆ WaitAll() [3/3]

static bool System::Threading::WaitHandle::WaitAll ( const System::ArrayPtr< System::SharedPtr< WaitHandle >> &  waitHandles,
TimeSpan  timeout 
)
static

Waits for all handles to fire.

Parameters
waitHandlesHandles to wait for.
timeoutA System::TimeSpan that represents the number of milliseconds to wait, or a System::TimeSpan that represents -1 milliseconds to wait indefinitely.
Returns
True if all handles fired, false if timeout exceeded.

◆ WaitAny() [1/3]

static int System::Threading::WaitHandle::WaitAny ( const System::ArrayPtr< System::SharedPtr< WaitHandle >> &  waitHandles)
static

Waits for any of the handles to fire.

Parameters
waitHandlesHandles to wait for.
Returns
True when every element in waitHandles has received a signal; otherwise the method never returns.

◆ WaitAny() [2/3]

static int System::Threading::WaitHandle::WaitAny ( const System::ArrayPtr< System::SharedPtr< WaitHandle >> &  waitHandles,
int  millisecondsTimeout 
)
static

Waits for any of the handles to fire.

Parameters
waitHandlesHandles to wait for.
millisecondsTimeoutTimeout to wait for, in milliseconds; -1 means infinite waiting, 0 means check-and-return, positive values are timeouts.
Returns
True if any handle fired, false if timeout exceeded.

◆ WaitAny() [3/3]

static int System::Threading::WaitHandle::WaitAny ( const System::ArrayPtr< System::SharedPtr< WaitHandle >> &  waitHandles,
TimeSpan  timeout 
)
static

Waits for any of the handles to fire.

Parameters
waitHandlesHandles to wait for.
timeoutA System::TimeSpan that represents the number of milliseconds to wait, or a System::TimeSpan that represents -1 milliseconds to wait indefinitely.
Returns
True if any handle fired, false if timeout exceeded.

◆ WaitMultiple()

static int System::Threading::WaitHandle::WaitMultiple ( const System::ArrayPtr< System::SharedPtr< WaitHandle >> &  waitHandles,
int  millisecondsTimeout,
bool  waitAll,
int &  index 
)
staticprotected

Implementation of waiting for multiple objects.

Parameters
waitHandlesHandles to wait for.
millisecondsTimeoutTimeout to wait for, in milliseconds; -1 means infinite waiting, 0 means check-and-return, positive values are timeouts.
waitAllIf true, waits for all handles, otherwise waits for just one.
indexStores index of signalled obejct here.
Returns
0 if awaited event occurs, non-zero value otherwise.

◆ WaitOne() [1/4]

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

Waits for the handle to fire for unlimited period.

Returns
Always returns true as no timeout occurs.

Reimplemented in System::Threading::Semaphore, and System::Threading::Mutex.

◆ WaitOne() [2/4]

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

Waits for the handle to fire.

Parameters
millisecondsTimeoutTimeout to wait for, in milliseconds; -1 means infinite waiting, 0 means check-and-return, positive values are timeouts.
Returns
True if handle fired, false if timeout exceeded.

Reimplemented in System::Threading::Semaphore, and System::Threading::Mutex.

◆ WaitOne() [3/4]

virtual bool System::Threading::WaitHandle::WaitOne ( int  millisecondsTimeout,
bool  exitContext 
)
virtual

Waits for the handle to fire.

Parameters
millisecondsTimeoutTimeout to wait for, in milliseconds; -1 means infinite waiting, 0 means check-and-return, positive values are timeouts.
exitContextIf true, waiting should drop the lock on the handle before waiting for it.
Returns
True if handle fired, false if timeout exceeded.

◆ WaitOne() [4/4]

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

Waits for the handle to fire.

Parameters
timeoutA System::TimeSpan that represents the number of milliseconds to wait, or a System::TimeSpan that represents -1 milliseconds to wait indefinitely.
Returns
True if handle fired, false if timeout exceeded.

Reimplemented in System::Threading::Mutex.

Member Data Documentation

◆ WaitTimeout

const int System::Threading::WaitHandle::WaitTimeout = 0x102
static

Special value to be returned by the function otherwise returning index of signalled object in array, if timeout exceeds and nothing signals.