Programming Reference:Thread Class - Revision history

Mellinger: /* int OnExecute */

2023-04-18T15:22:20Z

int OnExecute

← Older revision		Revision as of 15:22, 18 April 2023
Line 22:		Line 22:
	int MyThread::OnExecute()		int MyThread::OnExecute()
	{		{
	while( !Terminating() )		while (!Terminating())
	{ // do something		{ // do something
	...		...
Line 29:		Line 29:
	}		}
	</pre>		</pre>

			When using a <tt>WaitableEvent</tt> object, the loop may look like this:
			<pre>
			int MyThread::OnExecute()
			{
			while (myEvent.Wait())
			{ // do something whenever the event gets signaled
			...
			}
			return 0;
			}
			</pre>

	==Properties==		==Properties==
	===bool Terminating (r)===		===bool Terminating (r)===

Mellinger: /* Synopsis */

2023-04-18T15:19:08Z

Synopsis

← Older revision		Revision as of 15:19, 18 April 2023
Line 3:		Line 3:

	==Synopsis==		==Synopsis==
	The <tt>Thread</tt> class provides a wrapper for OS-dependent thread functionality.		The <tt>Thread</tt> class provides a wrapper for OS-dependent thread functionality. Differently from <tt>std::thread</tt>, it works together with the <tt>WaitableEvent</tt> class, such that waits are automatically aborted when the thread's <tt>Terminate()</tt> function is called.

	==Methods==		==Methods==

Mellinger: Mellinger moved page Programming Reference:OSThread Class to Programming Reference:Thread Class

2023-04-18T15:15:47Z

Mellinger moved page Programming Reference:OSThread Class to Programming Reference:Thread Class

← Older revision		Revision as of 15:15, 18 April 2023
(No difference)

Mellinger at 15:11, 18 April 2023

2023-04-18T15:11:19Z

← Older revision		Revision as of 15:11, 18 April 2023
Line 1:		Line 1:
	==Location==		==Location==
	<tt>BCI2000/src/shared/utils</tt>		<tt>BCI2000/src/shared/utils/Lib</tt>

	==Synopsis==		==Synopsis==
	The <tt>~~OSThread~~</tt> class provides a wrapper for OS-dependent thread functionality.		The <tt>Thread</tt> class provides a wrapper for OS-dependent thread functionality.

	==Methods==		==Methods==
	===~~OSThread~~()===		===Thread()===
	All threads are created in suspended state, and resumed by calling their ''Start()'' function.		All threads are created in suspended state, and resumed by calling their ''Start()'' function.
	===~~~OSThread~~()===		===~Thread()===
	Deleting an <tt>~~OSThread~~</tt> object with a running thread associated will kill the thread, resulting in an undefined state of the parent process. Make sure that the <tt>~~IsTerminated~~</tt> property is ''true'' before deleting the <tt>~~OSThread~~</tt> object.		Deleting an <tt>Thread</tt> object with a running thread associated will kill the thread, resulting in an undefined state of the parent process. Make sure that the <tt>Terminated</tt> property is ''true'' before deleting the <tt>Thread</tt> object.
	===Start()===		===Start()===
	Starts thread execution.		Starts thread execution.
	===Terminate(~~[OSEvent*]~~)===		===bool Terminate(TimeUtils::Interval = TimeUtils::Forever)===
	Initiates thread termination by setting the <tt>Terminating</tt> property to ''true''. ~~When~~ a ~~pointer to an [[Programming Reference::OSEvent Class\|<tt>OSEvent</tt>]] object~~ is specified ~~as an argument~~, ~~the [[Programming Reference::OSEvent Class\|<tt>OSEvent</tt>]] object~~ will ~~be set to signaled state as soon as thread execution has terminated~~.		Initiates thread termination by setting the <tt>Terminating</tt> property to ''true'', and waits for the thread to terminate.
			If a finite timeout is specified, and it expires, it will return with a result of ''false''. Otherwise, it will return ''true''.
	~~==Static Methods==~~
	~~===Sleep( int ms )===~~
	~~Puts the current thread to sleep for the amount of time specified in ms~~.

	==Events==		==Events==
	===int ~~Execute~~===		===int OnExecute===
	This is the thread's main function. Typically, it will consist of a processing loop that exits when the thread's <tt>IsTerminating</tt> property becomes ''true'':		This is the thread's main function. Typically, it will consist of a processing loop that exits when the thread's <tt>IsTerminating</tt> property becomes ''true'':
	<pre>		<pre>
	int MyThread::~~Execute~~()		int MyThread::OnExecute()
	{		{
	while( !~~IsTerminating~~() )		while( !Terminating() )
	{ // do something		{ // do something
	...		...
Line 33:		Line 30:
	</pre>		</pre>
	==Properties==		==Properties==
	===bool ~~IsTerminating~~ (r)===		===bool Terminating (r)===
	True after <tt>Terminate()</tt> has been called on the thread.		True after <tt>Terminate()</tt> has been called on the thread.
	===bool ~~IsTerminated~~ (r)===		===bool Terminated (r)===
	True after the thread has been terminated.		True after the thread has been terminated.
	===int Result (r)===		===int Result (r)===
	The return code of the thread's <tt>~~Execute~~()</tt> function on termination of the thread.		The return code of the thread's <tt>OnExecute()</tt> function on termination of the thread.

	[[Programming Reference:~~OSEvent Class]], [[Programming Reference:OSMutex~~ Class]]		[[Programming Reference:WaitableEvent Class]]

	[[Category:Framework API]][[Category:Development]]		[[Category:Framework API]][[Category:Development]]

Mellinger at 14:49, 2 May 2011

2011-05-02T14:49:33Z

← Older revision		Revision as of 14:49, 2 May 2011
Line 39:		Line 39:
	===int Result (r)===		===int Result (r)===
	The return code of the thread's <tt>Execute()</tt> function on termination of the thread.		The return code of the thread's <tt>Execute()</tt> function on termination of the thread.

			[[Programming Reference:OSEvent Class]], [[Programming Reference:OSMutex Class]]

	[[Category:Framework API]][[Category:Development]]		[[Category:Framework API]][[Category:Development]]

Mellinger: /* Terminate() */

2011-05-02T14:31:50Z

Terminate()

← Older revision		Revision as of 14:31, 2 May 2011
Line 12:		Line 12:
	===Start()===		===Start()===
	Starts thread execution.		Starts thread execution.
	===Terminate()===		===Terminate([OSEvent*])===
	Initiates thread termination by setting the <tt>Terminating</tt> property to ''true''.		Initiates thread termination by setting the <tt>Terminating</tt> property to ''true''. When a pointer to an [[Programming Reference::OSEvent Class\|<tt>OSEvent</tt>]] object is specified as an argument, the [[Programming Reference::OSEvent Class\|<tt>OSEvent</tt>]] object will be set to signaled state as soon as thread execution has terminated.

	==Static Methods==		==Static Methods==

Mellinger: /* Sleep( int ms ) */

2011-01-19T16:11:25Z

Sleep( int ms )

← Older revision		Revision as of 16:11, 19 January 2011
Line 17:		Line 17:
	==Static Methods==		==Static Methods==
	===Sleep( int ms )===		===Sleep( int ms )===
	Puts the thread to sleep for the amount of time specified in ms.		Puts the current thread to sleep for the amount of time specified in ms.

	==Events==		==Events==

Mellinger: /* Methods */

2011-01-19T16:11:13Z

Methods

← Older revision		Revision as of 16:11, 19 January 2011
Line 8:		Line 8:
	===OSThread()===		===OSThread()===
	All threads are created in suspended state, and resumed by calling their ''Start()'' function.		All threads are created in suspended state, and resumed by calling their ''Start()'' function.

	===~OSThread()===		===~OSThread()===
	Deleting an <tt>OSThread</tt> object with a running thread associated will kill the thread, resulting in an undefined state of the parent process. Make sure that the <tt>IsTerminated</tt> property is ''true'' before deleting the <tt>OSThread</tt> object.		Deleting an <tt>OSThread</tt> object with a running thread associated will kill the thread, resulting in an undefined state of the parent process. Make sure that the <tt>IsTerminated</tt> property is ''true'' before deleting the <tt>OSThread</tt> object.
Line 15:		Line 14:
	===Terminate()===		===Terminate()===
	Initiates thread termination by setting the <tt>Terminating</tt> property to ''true''.		Initiates thread termination by setting the <tt>Terminating</tt> property to ''true''.

			==Static Methods==
			===Sleep( int ms )===
			Puts the thread to sleep for the amount of time specified in ms.

	==Events==		==Events==

Mellinger: /* Properties */

2011-01-19T16:09:57Z

Properties

← Older revision		Revision as of 16:09, 19 January 2011
Line 30:		Line 30:
	</pre>		</pre>
	==Properties==		==Properties==
	~~===int ID (r)===~~
	~~The thread's OS thread id, or zero if the thread is not running.~~
	===bool IsTerminating (r)===		===bool IsTerminating (r)===
	True after <tt>Terminate()</tt> has been called on the thread.		True after <tt>Terminate()</tt> has been called on the thread.

Mellinger: /* OSThread(bool createSuspended=false) */

2011-01-19T16:09:37Z

OSThread(bool createSuspended=false)

← Older revision		Revision as of 16:09, 19 January 2011
Line 6:		Line 6:

	==Methods==		==Methods==
	===OSThread(~~bool createSuspended=false~~)===		===OSThread()===
	~~The thread's constructor's argument determines whether thread execution is started immediately, or whether the thread is initially put into~~ suspended state~~. By default~~, ~~the thread is created unsuspended~~.		All threads are created in suspended state, and resumed by calling their ''Start()'' function.

	===~OSThread()===		===~OSThread()===