common::Thread Class Reference

#include <thread.h>

Collaboration diagram for common::Thread:

[legend]

Public Member Functions
	Thread ()
	Constructors and destructors.
	~Thread ()
bool	start ()
	Run thread.
void	stop (bool cancel_all_tasks=true)
	Stop current thread.
bool	append_task (Task *new_task)
	Append the task to the end of the task queue.
bool	prepend_task (Task *new_task, bool abort_current)
	Insert the task to the head of the task queue.
void	clear_all ()
	Remove all tasks in the task queue.

---

Detailed Description

Definition at line 103 of file thread.h.

---

Constructor & Destructor Documentation

common::Thread::Thread

(

)

Constructors and destructors.

Definition at line 44 of file thread.cpp.

: thread(NULL),
  thread_cmd(CMD_NONE),
  running_task(0)
{
    queue_mutex = g_mutex_new();

common::Thread::~Thread

(

)

Definition at line 53 of file thread.cpp.

{
    g_mutex_free(queue_mutex);

---

Member Function Documentation

bool common::Thread::append_task

(

Task *

new_task

)

Append the task to the end of the task queue.

Definition at line 164 of file thread.cpp.

Referenced by text::TextController::paginate().

{
    if (thread_cmd == CMD_NONE)
    {
        // Append task to the end of the task queue.
        g_mutex_lock(queue_mutex);
        task_queue.push_back(new_task);
        g_mutex_unlock(queue_mutex);

        // Tells the worker thread that a new task is available.
        g_cond_signal(queue_cond);
        return true;
    }
    else
    {
        delete new_task;
        return false;

Here is the caller graph for this function:

void common::Thread::clear_all

(

)

Remove all tasks in the task queue.

Definition at line 109 of file thread.cpp.

Referenced by images::ImagesRenderer::render().

{
    g_mutex_lock(queue_mutex);

    std::list<Task*>::iterator it = task_queue.begin();
    while (it != task_queue.end())
    {
        delete *it;
        it = task_queue.erase(it);
    }

Here is the caller graph for this function:

bool common::Thread::prepend_task	(	Task *	new_task,
		bool	abort_current
	)

Insert the task to the head of the task queue.

Parameters:

abort_current

This flag tells the thread that after inserting the new task to the head of the queue, abort current running task immediately. We should NOT give user a capability to abort the running task because the aborted task may generate a new task, and put it to the end of the queue, which may be executed by worker thread immediately. That is NOT we want.

Definition at line 184 of file thread.cpp.

Referenced by text::TextController::pause_pagination(), text::TextController::render(), images::ImagesRenderer::render(), and text::TextController::search().

{
    if (thread_cmd == CMD_NONE)
    {
        // Insert task to the beginning of the task queue.
        g_mutex_lock(queue_mutex);
        task_queue.push_front(new_task);

        if (abort_current)
        {
            abort_current_task();
        }

        g_mutex_unlock(queue_mutex);

        // Tells the worker thread that a new task is available.
        g_cond_signal(queue_cond);

        return true;
    }
    else
    {
        delete new_task;
        return false;

Here is the caller graph for this function:

bool common::Thread::start

(

)

Run thread.

Definition at line 123 of file thread.cpp.

Referenced by images::ImagesRenderer::ImagesRenderer(), and text::TextController::start().

{
    if (thread != NULL)
    {
        // The thread has been started.
        return false;
    }

    thread = g_thread_create(thread_func, this, TRUE, NULL);

Here is the caller graph for this function:

void common::Thread::stop

(

bool

cancel_all_tasks = true

)

Stop current thread.

Definition at line 135 of file thread.cpp.

Referenced by text::TextController::stop(), images::ImagesRenderer::stop(), and images::ImagesRenderer::~ImagesRenderer().

{
    if (thread == NULL)
    {
        return;
    }

    thread_cmd = cancel_all_tasks ? CMD_TERMINATE : CMD_STOP;

    if (running_task != 0)
    {
        if (cancel_all_tasks)
        {
            running_task->send_abort_request();
        }
    }
    else
    {
        // Woker thread is waiting for a task, wake it up.
        g_cond_signal(queue_cond);
    }

    // Wait for worker thread to die.
    g_thread_join(thread);

    // Set the thread to be NULL

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• thread.h
• thread.cpp