Asposecpplib
System::Threading::Semaphore Class Reference

Semaphore implementation. 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 Semaphore (int initialCount, int maximumCount)
 Creates unnamed semaphore. More...
 
ASPOSECPP_SHARED_API Semaphore (int initialCount, int maximumCount, const String &name)
 Creates named semaphore. More...
 
ASPOSECPP_SHARED_API Semaphore (int initialCount, int maximumCount, const String &name, bool &createdNew)
 Creates named semaphore. More...
 
virtual ASPOSECPP_SHARED_API bool Reset ()
 Sets semaphore to non-signalled state. Not supported. More...
 
virtual ASPOSECPP_SHARED_API bool Set ()
 Sets semaphore to signalled state. Not supported. More...
 
virtual ASPOSECPP_SHARED_API bool WaitOne () override
 Locks semaphore. Performs unlimited waiting if neccessary. More...
 
virtual ASPOSECPP_SHARED_API bool WaitOne (int millisecondsTimeout) override
 Locks semaphore. Performs waiting if neccessary. More...
 
ASPOSECPP_SHARED_API int Release ()
 Releases lock on semaphore. More...
 
ASPOSECPP_SHARED_API int Release (int releaseCount)
 Releases multiple locks on semaphore. More...
 
- Public Member Functions inherited from System::Threading::WaitHandle
virtual ASPOSECPP_SHARED_API bool WaitOne (TimeSpan timeout)
 Waits for the handle to fire. More...
 
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 refernce 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 int 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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 ()
 Impleemnts 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 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...
 

Detailed Description

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

◆ Semaphore() [1/3]

ASPOSECPP_SHARED_API System::Threading::Semaphore::Semaphore ( int  initialCount,
int  maximumCount 
)

Creates unnamed semaphore.

Parameters
initialCountInitial count of active entries.
maximumCountMaximum allwed entries count.

◆ Semaphore() [2/3]

ASPOSECPP_SHARED_API System::Threading::Semaphore::Semaphore ( int  initialCount,
int  maximumCount,
const String name 
)

Creates named semaphore.

Parameters
initialCountInitial count of active entries.
maximumCountMaximum allwed entries count.
nameSemaphore name.

◆ Semaphore() [3/3]

ASPOSECPP_SHARED_API System::Threading::Semaphore::Semaphore ( int  initialCount,
int  maximumCount,
const String name,
bool &  createdNew 
)

Creates named semaphore.

Parameters
initialCountInitial count of active entries.
maximumCountMaximum allwed entries count.
nameSemaphore name.
createdNewReference to variable which is set to true if semaphore was created and to false if existing one with same name was reused

Member Function Documentation

◆ Release() [1/2]

ASPOSECPP_SHARED_API int System::Threading::Semaphore::Release ( )

Releases lock on semaphore.

Returns
The count of locks just before Release() was called.

◆ Release() [2/2]

ASPOSECPP_SHARED_API int System::Threading::Semaphore::Release ( int  releaseCount)

Releases multiple locks on semaphore.

Parameters
releaseCountNumber of locks to release.
Returns
The count of locks just before Release() was called.

◆ Reset()

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

Sets semaphore to non-signalled state. Not supported.

◆ Set()

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

Sets semaphore to signalled state. Not supported.

◆ WaitOne() [1/2]

virtual ASPOSECPP_SHARED_API bool System::Threading::Semaphore::WaitOne ( )
overridevirtual

Locks semaphore. Performs unlimited waiting if neccessary.

Returns
Always returns true as it does not return until semaphore is locked.

Reimplemented from System::Threading::WaitHandle.

◆ WaitOne() [2/2]

virtual ASPOSECPP_SHARED_API bool System::Threading::Semaphore::WaitOne ( int  millisecondsTimeout)
overridevirtual

Locks semaphore. Performs waiting if neccessary.

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

Reimplemented from System::Threading::WaitHandle.