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

#include <thread.h>

Inherits System::Object.

Public Member Functions
	Thread ()
	Constructor. More...

	Thread (ThreadStart thread_function)
	Constructor. More...

	Thread (ParameterizedThreadStart thread_function)
	Constructor. More...

Thread &	operator= (const Thread &t)
	Copies TLS data from different thread. More...

	Thread (Thread &t)
	Copy constructor. More...

virtual	~Thread ()
	Destructor. More...

SharedPtr< Globalization::CultureInfo >	get_CurrentCulture ()
	Gets thread culture. More...

void	set_CurrentCulture (const SharedPtr< Globalization::CultureInfo > &ci)
	Sets thread culture. More...

SharedPtr< Globalization::CultureInfo >	get_CurrentUICulture ()
	Gets user interface culture used by thread. More...

void	set_CurrentUICulture (const SharedPtr< Globalization::CultureInfo > &ci)
	Sets user interface culture used by thread. More...

bool	get_IsAlive ()
	Checks whether thread is alive. More...

bool	get_IsBackground ()
	Checks whether thread is background. More...

void	set_IsBackground (bool is_background)
	Sets thread to background or foreground. More...

bool	get_IsThreadPoolThread ()
	Checks if thread is owned by a thread pool. More...

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

System::String	get_Name ()
	Gets thread name. More...

void	set_Name (const System::String &name)
	Sets thread name. More...

ThreadState	get_ThreadState ()
	Gets thread state. More...

void	Join ()
	Joins managed thread. Performs unlimited waiting if required. More...

bool	Join (int millisecondsTimeout)
	Joins managed thread. Performs limited waiting. More...

bool	Join (TimeSpan timeout)
	Joins managed thread. Performs limited waiting. More...

void	Start ()
	Starts thread using null argument object. More...

void	Start (const System::SharedPtr< System::Object > &o)
	Starts thread. More...

void	Abort ()
	Aborts thread. Not implemented. More...

void	Interrupt ()
	Interrupt thread. Not implemented. More...

virtual int	GetHashCode () const override

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

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

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 TypeInfo &	GetType () 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 System::SharedPtr< Thread >	get_CurrentThread ()
	Gets object which describes current thread. More...

static void	Sleep (int millisecondsTimeout)
	Stops current thread for specified timeout. More...

static void	Sleep (TimeSpan timeout)
	Stops current thread for specified timeout. More...

static void	SpinWait (int iterations)
	Waits for specific number of loop iterations. More...

static bool	Yield ()
	Yields thread. More...

static int	GetCurrentThreadId ()
	Gets identifier of current thread. More...

static 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 TypeInfo &	Type ()
	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...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. 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.

#include "system/threading/thread.h"
#include "system/smart_ptr.h"
 
int main()
{
  auto thread = System::MakeObject<System::Threading::Thread>([]()
  {
    std::cout << "Child thread ID: " << System::Threading::Thread::GetCurrentThreadId() << std::endl;
    System::Threading::Thread::Sleep(200);
  });
 
  std::cout << "Main thread ID: " << System::Threading::Thread::GetCurrentThreadId() << std::endl;
 
  thread->Start();
  thread->Join();
 
  return 0;
}
/*
This code example produces the following output:
Main thread ID: 2
Child thread ID: 1
*/

Constructor & Destructor Documentation

◆ Thread() [1/4]

System::Threading::Thread::Thread ( )

Constructor.

◆ Thread() [2/4]

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

Constructor.

Parameters

thread_function Function to be executed by thread.

◆ Thread() [3/4]

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

Constructor.

Parameters

thread_function Function to be executed by thread.

◆ Thread() [4/4]

System::Threading::Thread::Thread ( Thread & t )

Copy constructor.

Parameters

t	Thread to copy data from.

◆ ~Thread()

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

virtual

Destructor.

Member Function Documentation

◆ Abort()

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

Aborts thread. Not implemented.

◆ get_CurrentCulture()

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

Gets thread culture.

Returns: Culture used by thread.

◆ get_CurrentThread()

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

static

Gets object which describes current thread.

Returns: Thread object.

◆ get_CurrentUICulture()

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

Gets user interface culture used by thread.

Returns: Culture used by thread UI.

◆ get_IsAlive()

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

Checks whether thread is alive.

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

◆ get_IsBackground()

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

Checks whether thread is background.

Returns: True is thread is background, false otherwise.

◆ get_IsThreadPoolThread()

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

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

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

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

Gets thread name.

Returns: Thread name.

◆ get_ThreadState()

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

Gets thread state.

Returns: State of controlled thread.

◆ GetCurrentThreadId()

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

static

Gets identifier of current thread.

Returns: Pseudo-unique identifier of current thread.

◆ GetHashCode()

virtual int System::Threading::Thread::GetHashCode ( ) const

overridevirtual

See also: Object::GetHashCode

Reimplemented from System::Object.

◆ Interrupt()

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

Interrupt thread. Not implemented.

◆ Join() [1/3]

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

Joins managed thread. Performs unlimited waiting if required.

◆ Join() [2/3]

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

Joins managed thread. Performs limited waiting.

Parameters

millisecondsTimeout Waiting timeout in milliseconds.

Returns: True if thread was successfully joined, false if timeout exceeded.

◆ Join() [3/3]

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

Joins managed thread. Performs limited waiting.

Parameters

timeout A 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 void System::Threading::Thread::MemoryBarrier ( )

static

Synchronizes memory access.

◆ operator=()

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

Copies TLS data from different thread.

Parameters

t	Thread to copy data from.

Returns: Self reference.

◆ set_CurrentCulture()

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

Sets thread culture.

Parameters

ci	Culture to be used by thread.

◆ set_CurrentUICulture()

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

Sets user interface culture used by thread.

◆ set_IsBackground()

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

Sets thread to background or foreground.

Parameters

is_background If true, set thread to background, otherwise to foreground.

◆ set_Name()

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

Sets thread name.

Parameters

name	Thread name.

◆ Sleep() [1/2]

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

static

Stops current thread for specified timeout.

Parameters

millisecondsTimeout Timeout to sleep in milliseconds.

◆ Sleep() [2/2]

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

static

Stops current thread for specified timeout.

Parameters

timeout Timeout to sleep.

◆ SpinWait()

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

static

Waits for specific number of loop iterations.

Parameters

iterations How many loops to wait for.

◆ Start() [1/2]

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

Starts thread using null argument object.

◆ Start() [2/2]

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

Starts thread.

Parameters

o	Object to pass to thread function as argument.

◆ Yield()

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

static

Yields thread.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Thread() [1/4]

◆ Thread() [2/4]

◆ Thread() [3/4]

◆ Thread() [4/4]

◆ ~Thread()

Member Function Documentation

◆ Abort()

◆ get_CurrentCulture()

◆ get_CurrentThread()

◆ get_CurrentUICulture()

◆ get_IsAlive()

◆ get_IsBackground()

◆ get_IsThreadPoolThread()

◆ get_ManagedThreadId()

◆ get_Name()

◆ get_ThreadState()

◆ GetCurrentThreadId()

◆ GetHashCode()

◆ Interrupt()

◆ Join() [1/3]

◆ Join() [2/3]

◆ Join() [3/3]

◆ MemoryBarrier()

◆ operator=()

◆ set_CurrentCulture()

◆ set_CurrentUICulture()

◆ set_IsBackground()

◆ set_Name()

◆ Sleep() [1/2]

◆ Sleep() [2/2]

◆ SpinWait()

◆ Start() [1/2]

◆ Start() [2/2]

◆ Yield()