Represents a running thread. More...
Classes | |
class | Exit |
Exception class used to exit from a thread. More... | |
Public Member Functions | |
bool | joinable () const |
Returns whether the thread is joinable. | |
void | join () |
Waits until the thread finishes. | |
void | set_priority (ThreadPriority priority) |
Changes the priority of the thread to priority. | |
ThreadPriority | get_priority () const |
Returns the priority of the thread. | |
GThread* | gobj () |
const GThread* | gobj () const |
Static Public Member Functions | |
static Thread* | create (const sigc::slot< void >& slot, bool joinable) |
Creates a new thread with the priority THREAD_PRIORITY_NORMAL . | |
static Thread* | create (const sigc::slot< void >& slot, unsigned long stack_size, bool joinable, bool bound, ThreadPriority priority) |
Creates a new thread with the priority priority. | |
static Thread* | self () |
Returns the Thread* corresponding to the calling thread. | |
static void | yield () |
Gives way to other threads waiting to be scheduled. | |
Related Functions | |
(Note that these are not member functions.) | |
Thread* | wrap (GThread* gobject) |
Represents a running thread.
An instance of this class can only be obtained with create(), self(), or wrap(GThread*). It's not possible to delete a Thread object. If the thread is not joinable, its resources will be freed automatically when it exits. Otherwise, if the thread is joinable, you must call join() to avoid a memory leak.
static Thread* Glib::Thread::create | ( | const sigc::slot< void > & | slot, | |
unsigned long | stack_size, | |||
bool | joinable, | |||
bool | bound, | |||
ThreadPriority | priority | |||
) | [static] |
Creates a new thread with the priority priority.
The stack gets the size stack_size or the default value for the current platform, if stack_size is 0
.
If joinable is true
, you can wait for this thread's termination by calling join(). Otherwise the thread will just disappear, when ready. If bound is true
, this thread will be scheduled in the system scope, otherwise the implementation is free to do scheduling in the process scope. The first variant is more expensive resource-wise, but generally faster. On some systems (e.g. Linux) all threads are bound.
The new thread executes the function or method slot points to. You can pass additional arguments using sigc::bind(). If the thread was created successfully, it is returned.
Because sigc::trackable is not thread safe, if the slot represents a non-static class method (that is, it is created by sigc::mem_fun()), the class concerned should not derive from sigc::trackable.
Glib::THREAD_PRIORITY_NORMAL
here as a default.slot | A slot to execute in the new thread. | |
stack_size | A stack size for the new thread, or 0 . | |
joinable | Should this thread be joinable? | |
bound | Should this thread be bound to a system thread? | |
priority | A priority for the thread. |
Glib::ThreadError |
static Thread* Glib::Thread::create | ( | const sigc::slot< void > & | slot, | |
bool | joinable | |||
) | [static] |
Creates a new thread with the priority THREAD_PRIORITY_NORMAL
.
If joinable is true
, you can wait for this thread's termination by calling join(). Otherwise the thread will just disappear, when ready.
The new thread executes the function or method slot points to. You can pass additional arguments using sigc::bind(). If the thread was created successfully, it is returned, otherwise a ThreadError exception is thrown.
Because sigc::trackable is not thread safe, if the slot represents a non-static class method (that is, it is created by sigc::mem_fun()), the class concerned should not derive from sigc::trackable.
slot | A slot to execute in the new thread. | |
joinable | Should this thread be joinable? |
Glib::ThreadError |
ThreadPriority Glib::Thread::get_priority | ( | ) | const |
Returns the priority of the thread.
const GThread* Glib::Thread::gobj | ( | ) | const [inline] |
GThread* Glib::Thread::gobj | ( | ) | [inline] |
void Glib::Thread::join | ( | ) |
Waits until the thread finishes.
Waits until the thread finishes, i.e. the slot, as given to create(), returns or g_thread_exit() is called by the thread. (Calling g_thread_exit() in a C++ program should be avoided.) All resources of the thread including the Glib::Thread object are released. The thread must have been created with joinable = true
.
bool Glib::Thread::joinable | ( | ) | const |
Returns whether the thread is joinable.
static Thread* Glib::Thread::self | ( | ) | [static] |
Returns the Thread* corresponding to the calling thread.
void Glib::Thread::set_priority | ( | ThreadPriority | priority | ) |
Changes the priority of the thread to priority.
root
can increase priorities. On other systems (e.g. Solaris) there doesn't seem to be different scheduling for different priorities. All in all try to avoid being dependent on priorities. priority | A new priority for the thread. |
static void Glib::Thread::yield | ( | ) | [static] |
Gives way to other threads waiting to be scheduled.
This function is often used as a method to make busy wait less evil. But in most cases, you will encounter, there are better methods to do that. So in general you shouldn't use this function.