Asposecpplib
System::Threading::Thread Class Referencefinal

Thread 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::Object.

Public Member Functions

ASPOSECPP_SHARED_API Thread (bool do_delete=false)
 Constructor. More...
 
ASPOSECPP_SHARED_API Thread (ThreadStart thread_function)
 Constructor. More...
 
ASPOSECPP_SHARED_API Thread (ParameterizedThreadStart thread_function)
 Constructor. More...
 
ASPOSECPP_SHARED_API Threadoperator= (const Thread &t)
 Copies TLS data from different thread. More...
 
ASPOSECPP_SHARED_API Thread (Thread &t)
 Copy constructor. More...
 
virtual ASPOSECPP_SHARED_API ~Thread ()
 Destructor. More...
 
ASPOSECPP_SHARED_API SharedPtr< Globalization::CultureInfoget_CurrentCulture ()
 Gets thread culture. More...
 
ASPOSECPP_SHARED_API void set_CurrentCulture (const SharedPtr< Globalization::CultureInfo > &ci)
 Sets thread culture. More...
 
ASPOSECPP_SHARED_API SharedPtr< Globalization::CultureInfoget_CurrentUICulture ()
 Gets user interface culture used by thread. More...
 
ASPOSECPP_SHARED_API void set_CurrentUICulture (const SharedPtr< Globalization::CultureInfo > &ci)
 Sets user interface culture used by thread. More...
 
ASPOSECPP_SHARED_API bool get_IsAlive ()
 Checks whether thread is alive. More...
 
ASPOSECPP_SHARED_API bool get_IsBackground ()
 Checks whether thread is background. More...
 
ASPOSECPP_SHARED_API void set_IsBackground (bool is_background)
 Sets thread to background or foreground. More...
 
ASPOSECPP_SHARED_API bool get_IsThreadPoolThread ()
 Checks if thread is owned by a thread pool. More...
 
ASPOSECPP_SHARED_API int get_ManagedThreadId ()
 Gets identifier of thread. Can be got from OS, but if OS thread identifier exceeds int limits, ids of threads can intersect. More...
 
ASPOSECPP_SHARED_API System::String get_Name ()
 Gets thread name. More...
 
ASPOSECPP_SHARED_API void set_Name (const System::String &name)
 Sets thread name. More...
 
ASPOSECPP_SHARED_API ThreadState get_ThreadState ()
 Gets thread state. More...
 
ASPOSECPP_SHARED_API void Join ()
 Joins managed thread. Performs unlimited waiting if required. More...
 
ASPOSECPP_SHARED_API bool Join (int millisecondsTimeout)
 Joins managed thread. Performs limited waiting. More...
 
ASPOSECPP_SHARED_API bool Join (TimeSpan timeout)
 Joins managed thread. Performs limited waiting. More...
 
ASPOSECPP_SHARED_API void Start ()
 Starts thread using null argument object. More...
 
ASPOSECPP_SHARED_API void Start (const System::SharedPtr< System::Object > &o)
 Starts thread. More...
 
ASPOSECPP_SHARED_API void Abort ()
 Aborts thread. Not implemented. More...
 
ASPOSECPP_SHARED_API void Interrupt ()
 Interrupt thread. Not implemented. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const override
 
- 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 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...
 

Static Public Member Functions

static ASPOSECPP_SHARED_API System::SharedPtr< Threadget_CurrentThread ()
 Gets object which describes current thread. More...
 
static ASPOSECPP_SHARED_API void Sleep (int millisecondsTimeout)
 Stops current thread for specified timeout. More...
 
static ASPOSECPP_SHARED_API void Sleep (TimeSpan timeout)
 Stops current thread for specified timeout. More...
 
static ASPOSECPP_SHARED_API void SpinWait (int iterations)
 Waits for specific number of loop iterations. More...
 
static ASPOSECPP_SHARED_API bool Yield ()
 Yields thread. More...
 
static ASPOSECPP_SHARED_API int GetCurrentThreadId ()
 Gets identifier of current thread. More...
 
static ASPOSECPP_SHARED_API void MemoryBarrier ()
 Synchronizes memory access. 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...
 

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

Detailed Description

Thread 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

◆ Thread() [1/4]

ASPOSECPP_SHARED_API System::Threading::Thread::Thread ( bool  do_delete = false)

Constructor.

Parameters
do_deleteWhether to delete TLS data on thread termination.

◆ Thread() [2/4]

ASPOSECPP_SHARED_API System::Threading::Thread::Thread ( ThreadStart  thread_function)

Constructor.

Parameters
thread_functionFunction to be executed by thread.

◆ Thread() [3/4]

ASPOSECPP_SHARED_API System::Threading::Thread::Thread ( ParameterizedThreadStart  thread_function)

Constructor.

Parameters
thread_functionFunction to be executed by thread.

◆ Thread() [4/4]

ASPOSECPP_SHARED_API System::Threading::Thread::Thread ( Thread t)

Copy constructor.

Parameters
tThread to copy data from.

◆ ~Thread()

virtual ASPOSECPP_SHARED_API System::Threading::Thread::~Thread ( )
virtual

Destructor.

Member Function Documentation

◆ Abort()

ASPOSECPP_SHARED_API void System::Threading::Thread::Abort ( )

Aborts thread. Not implemented.

◆ get_CurrentCulture()

ASPOSECPP_SHARED_API SharedPtr<Globalization::CultureInfo> System::Threading::Thread::get_CurrentCulture ( )

Gets thread culture.

Returns
Culture used by thread.

◆ get_CurrentThread()

static ASPOSECPP_SHARED_API System::SharedPtr<Thread> System::Threading::Thread::get_CurrentThread ( )
static

Gets object which describes current thread.

Returns
Thread object.

◆ get_CurrentUICulture()

ASPOSECPP_SHARED_API SharedPtr<Globalization::CultureInfo> System::Threading::Thread::get_CurrentUICulture ( )

Gets user interface culture used by thread.

Returns
Culture used by thread UI.

◆ get_IsAlive()

ASPOSECPP_SHARED_API bool System::Threading::Thread::get_IsAlive ( )

Checks whether thread is alive.

Returns
True if thread is executing or joining, false otherwise.

◆ get_IsBackground()

ASPOSECPP_SHARED_API bool System::Threading::Thread::get_IsBackground ( )

Checks whether thread is background.

Returns
True is thread is background, false otherwise.

◆ get_IsThreadPoolThread()

ASPOSECPP_SHARED_API bool System::Threading::Thread::get_IsThreadPoolThread ( )

Checks if thread is owned by a thread pool.

Returns
True if thread is part of ThreadPool, false otherwise.

◆ get_ManagedThreadId()

ASPOSECPP_SHARED_API int System::Threading::Thread::get_ManagedThreadId ( )

Gets identifier of thread. Can be got from OS, but if OS thread identifier exceeds int limits, ids of threads can intersect.

Returns
Pseudo-unique thread identifier.

◆ get_Name()

ASPOSECPP_SHARED_API System::String System::Threading::Thread::get_Name ( )

Gets thread name.

Returns
Thread name.

◆ get_ThreadState()

ASPOSECPP_SHARED_API ThreadState System::Threading::Thread::get_ThreadState ( )

Gets thread state.

Returns
State of controlled thread.

◆ GetCurrentThreadId()

static ASPOSECPP_SHARED_API int System::Threading::Thread::GetCurrentThreadId ( )
static

Gets identifier of current thread.

Returns
Pseudo-unique identifier of current thread.

◆ GetHashCode()

virtual ASPOSECPP_SHARED_API int System::Threading::Thread::GetHashCode ( ) const
overridevirtual
See also
Object::GetHashCode

Reimplemented from System::Object.

◆ Interrupt()

ASPOSECPP_SHARED_API void System::Threading::Thread::Interrupt ( )

Interrupt thread. Not implemented.

◆ Join() [1/3]

ASPOSECPP_SHARED_API void System::Threading::Thread::Join ( )

Joins managed thread. Performs unlimited waiting if required.

◆ Join() [2/3]

ASPOSECPP_SHARED_API bool System::Threading::Thread::Join ( int  millisecondsTimeout)

Joins managed thread. Performs limited waiting.

Parameters
millisecondsTimeoutWaiting timeout in milliseconds.
Returns
True if thread was successfully joined, false if timeout exceeded.

◆ Join() [3/3]

ASPOSECPP_SHARED_API bool System::Threading::Thread::Join ( TimeSpan  timeout)

Joins managed thread. Performs limited waiting.

Parameters
timeoutA TimeSpan set to the amount of time to wait for the thread to terminate.
Returns
True if thread was successfully joined, false if timeout exceeded.

◆ MemoryBarrier()

static ASPOSECPP_SHARED_API void System::Threading::Thread::MemoryBarrier ( )
static

Synchronizes memory access.

◆ operator=()

ASPOSECPP_SHARED_API Thread& System::Threading::Thread::operator= ( const Thread t)

Copies TLS data from different thread.

Parameters
tThread to copy data from.
Returns
Self reference.

◆ set_CurrentCulture()

ASPOSECPP_SHARED_API void System::Threading::Thread::set_CurrentCulture ( const SharedPtr< Globalization::CultureInfo > &  ci)

Sets thread culture.

Parameters
ciCulture to be used by thread.

◆ set_CurrentUICulture()

ASPOSECPP_SHARED_API void System::Threading::Thread::set_CurrentUICulture ( const SharedPtr< Globalization::CultureInfo > &  ci)

Sets user interface culture used by thread.

Returns
Culture to be used by thread UI.

◆ set_IsBackground()

ASPOSECPP_SHARED_API void System::Threading::Thread::set_IsBackground ( bool  is_background)

Sets thread to background or foreground.

Parameters
is_backgroundIf true, set thread to background, otherwise to foreground.

◆ set_Name()

ASPOSECPP_SHARED_API void System::Threading::Thread::set_Name ( const System::String name)

Sets thread name.

Parameters
nameThread name.

◆ Sleep() [1/2]

static ASPOSECPP_SHARED_API void System::Threading::Thread::Sleep ( int  millisecondsTimeout)
static

Stops current thread for specified timeout.

Parameters
millisecondsTimeoutTimeout to sleep in milliseconds.

◆ Sleep() [2/2]

static ASPOSECPP_SHARED_API void System::Threading::Thread::Sleep ( TimeSpan  timeout)
static

Stops current thread for specified timeout.

Parameters
timeoutTimeout to sleep.

◆ SpinWait()

static ASPOSECPP_SHARED_API void System::Threading::Thread::SpinWait ( int  iterations)
static

Waits for specific number of loop iterations.

Parameters
iterationsHow many loops to wait for.

◆ Start() [1/2]

ASPOSECPP_SHARED_API void System::Threading::Thread::Start ( )

Starts thread using null argument object.

◆ Start() [2/2]

ASPOSECPP_SHARED_API void System::Threading::Thread::Start ( const System::SharedPtr< System::Object > &  o)

Starts thread.

Parameters
oObject to pass to thread function as argument.

◆ Yield()

static ASPOSECPP_SHARED_API bool System::Threading::Thread::Yield ( )
static

Yields thread.