CS::Threading::Thread Class Reference
Object representing a separate execution thread. More...
#include <csutil/threading/thread.h>
Inheritance diagram for CS::Threading::Thread:

Public Member Functions | |
ThreadPriority | GetPriority () const |
Get current execution priority for this thread. | |
bool | IsRunning () const |
Return whether thread is running or not. | |
bool | SetPriority (ThreadPriority prio) |
Set the current execution priority of this thread. | |
void | Start () |
Start the thread. | |
void | Stop () |
Unmercifully stop the thread as soon as possible. | |
Thread (Runnable *runnable, bool start, ThreadPriority prio) | |
Initialize a new thread object. | |
Thread (Runnable *runnable, ThreadPriority prio) | |
Initialize a new thread object. | |
Thread (Runnable *runnable, bool start=false) | |
Initialize a new thread object. | |
void | Wait () const |
Wait for thread to finish its execution. | |
~Thread () | |
Static Public Member Functions | |
static void | Yield () |
Yield Thread frees CPU time if nothing to do. |
Detailed Description
Object representing a separate execution thread.Used to create, manage and control execution threads.
Definition at line 92 of file thread.h.
Constructor & Destructor Documentation
CS::Threading::Thread::Thread | ( | Runnable * | runnable, | |
bool | start = false | |||
) | [inline] |
CS::Threading::Thread::Thread | ( | Runnable * | runnable, | |
ThreadPriority | prio | |||
) | [inline] |
Initialize a new thread object.
- Parameters:
-
runnable Runnable object to connect the thread to. prio Initial execution priority.
Definition at line 115 of file thread.h.
References SetPriority().
CS::Threading::Thread::Thread | ( | Runnable * | runnable, | |
bool | start, | |||
ThreadPriority | prio | |||
) | [inline] |
Initialize a new thread object.
- Parameters:
-
runnable Runnable object to connect the thread to. prio Initial execution priority. start If execution in the new thread should start immediately or if you have to start it manually.
Definition at line 128 of file thread.h.
References SetPriority(), and Start().
Member Function Documentation
ThreadPriority CS::Threading::Thread::GetPriority | ( | ) | const [inline] |
bool CS::Threading::Thread::IsRunning | ( | ) | const [inline] |
bool CS::Threading::Thread::SetPriority | ( | ThreadPriority | prio | ) | [inline] |
Set the current execution priority of this thread.
The specifics of when this takes effect and what underlying platform priority each value maps to are properties of the specific platform-based implementation.
- Returns:
- true if the priority was successfully set.
Definition at line 179 of file thread.h.
Referenced by Thread().
void CS::Threading::Thread::Start | ( | ) | [inline] |
void CS::Threading::Thread::Stop | ( | ) | [inline] |
Unmercifully stop the thread as soon as possible.
This method performs a dirty shutdown of the thread. The thread is not given a chance to exit normally. Do not invoke this method unless you have a very good reason for doing so. In general, it is best to implement some sort of communication with threads so that you can ask them to terminate in an orderly fashion.
Definition at line 159 of file thread.h.
Referenced by ~Thread().
void CS::Threading::Thread::Wait | ( | ) | const [inline] |
static void CS::Threading::Thread::Yield | ( | ) | [inline, static] |
The documentation for this class was generated from the following file:
- csutil/threading/thread.h
Generated for Crystal Space 1.2 by doxygen 1.4.7