Inherits System::Object.

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

Public Member Functions
virtual ASPOSECPP_SHARED_API bool	WaitOne ()

virtual ASPOSECPP_SHARED_API bool	WaitOne (int millisecondsTimeout)

virtual ASPOSECPP_SHARED_API bool	WaitOne (TimeSpan timeout)

virtual ASPOSECPP_SHARED_API bool	WaitOne (int millisecondsTimeout, bool exitContext)

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

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

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

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 TypeInfo &	GetType () 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	Equals (float const &objA, float const &objB)

template<>
bool	Equals (double const &objA, double const &objB)

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)

template<>
bool	ReferenceEquals (String const &str1, String const &str2)

Static Public Member Functions
static ASPOSECPP_SHARED_API bool	WaitAll (const System::ArrayPtr< System::SharedPtr< WaitHandle >> &waitHandles, int millisecondsTimeout)

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

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

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

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

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

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

Static Public Attributes
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...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	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 ASPOSECPP_SHARED_API System::Threading::WaitHandle::~WaitHandle ( )

virtual

Destructor.

Member Function Documentation

◆ Close()

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

virtual

Releases any resource associated with handle.

◆ get_Handle()

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

Gets handle.

Returns: Raw handle owned by object.

◆ WaitAll() [1/3]

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

static

Waits for all handles to fire.

Parameters

waitHandles	Handles to wait for.
millisecondsTimeout	Timeout 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() [2/3]

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

static

Waits for all handles to fire.

Parameters

waitHandles	Handles to wait for.
timeout	A 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.

◆ WaitAll() [3/3]

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

static

Waits for all handles to fire.

Parameters

waitHandles Handles to wait for.

Returns: True when every element in waitHandles has received a signal; otherwise the method never returns.

◆ WaitAny() [1/3]

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

static

Waits for any of the handles to fire.

Parameters

waitHandles	Handles to wait for.
millisecondsTimeout	Timeout 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() [2/3]

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

static

Waits for any of the handles to fire.

Parameters

waitHandles	Handles to wait for.
timeout	A 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.

◆ WaitAny() [3/3]

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

static

Waits for any of the handles to fire.

Parameters

waitHandles Handles to wait for.

Returns: True when every element in waitHandles has received a signal; otherwise the method never returns.

◆ WaitOne() [1/4]

virtual ASPOSECPP_SHARED_API 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::Mutex, and System::Threading::Semaphore.

◆ WaitOne() [2/4]

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

virtual

Waits for the handle to fire.

Parameters

millisecondsTimeout Timeout 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::Mutex, and System::Threading::Semaphore.

◆ WaitOne() [3/4]

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

virtual

Waits for the handle to fire.

Parameters

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

◆ WaitOne() [4/4]

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

virtual

Waits for the handle to fire.

Parameters

millisecondsTimeout	Timeout to wait for, in milliseconds; -1 means infinite waiting, 0 means check-and-return, positive values are timeouts.
exitContext	If true, waiting should drop the lock on the handle before waiting for it.

Returns: True if handle fired, false if timeout exceeded.

Member Data Documentation

◆ WaitTimeout

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~WaitHandle()

Member Function Documentation

◆ Close()

◆ get_Handle()

◆ WaitAll() [1/3]

◆ WaitAll() [2/3]

◆ WaitAll() [3/3]

◆ WaitAny() [1/3]

◆ WaitAny() [2/3]

◆ WaitAny() [3/3]

◆ WaitOne() [1/4]

◆ WaitOne() [2/4]

◆ WaitOne() [3/4]

◆ WaitOne() [4/4]

Member Data Documentation

◆ WaitTimeout