Programming Reference:Thread Class: Difference between revisions

← Older edit Newer edit →

Revision as of 15:11, 18 April 2023

Location

BCI2000/src/shared/utils/Lib

Synopsis

The Thread class provides a wrapper for OS-dependent thread functionality.

Methods

Thread()

All threads are created in suspended state, and resumed by calling their Start() function.

~Thread()

Deleting an Thread object with a running thread associated will kill the thread, resulting in an undefined state of the parent process. Make sure that the Terminated property is true before deleting the Thread object.

Start()

Starts thread execution.

bool Terminate(TimeUtils::Interval = TimeUtils::Forever)

Initiates thread termination by setting the Terminating 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.

Events

int OnExecute

This is the thread's main function. Typically, it will consist of a processing loop that exits when the thread's IsTerminating property becomes true:

int MyThread::OnExecute()
{
  while( !Terminating() )
  { // do something
    ...
  }
  return 0;
}

Properties

bool Terminating (r)

True after Terminate() has been called on the thread.

bool Terminated (r)

True after the thread has been terminated.

int Result (r)

The return code of the thread's OnExecute() function on termination of the thread.

Programming Reference:WaitableEvent Class

@@ Line 1: / Line 1: @@
 ==Location==
-<tt>BCI2000/src/shared/utils</tt>
+<tt>BCI2000/src/shared/utils/Lib</tt>
 ==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==
-===OSThread()===
+===Thread()===
 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()===
 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==
-===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'':
 <pre>
-int MyThread::Execute()
+int MyThread::OnExecute()
 {
-   while( !IsTerminating() )
+   while( !Terminating() )
    { // do something
      ...
@@ Line 33: / Line 30: @@
 </pre>
 ==Properties==
-===bool IsTerminating (r)===
+===bool Terminating (r)===
 True after <tt>Terminate()</tt> has been called on the thread.
-===bool IsTerminated (r)===
+===bool Terminated (r)===
 True after the thread has been terminated.
 ===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]]