pdf::Thread Class Reference

#include <pdf_thread.h>

Collaboration diagram for pdf::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	cancel_tasks (void *user_data=0)
	Cancel all of the tasks including current one.
void	clear_all (void *user_data=0, TaskType t=TASK_INVALID)
	Remove all tasks in the task queue.
bool	abort_task (void *user_data, TaskType t, unsigned int id)
	Abort or remove a given task.

---

Detailed Description

Definition at line 42 of file pdf_thread.h.

---

Constructor & Destructor Documentation

pdf::Thread::Thread

(

)

Constructors and destructors.

Definition at line 41 of file pdf_thread.cpp.

    : thread(NULL)
    , thread_cmd(CMD_NONE)
    , running_task(0)
{
}

pdf::Thread::~Thread

(

)

Definition at line 48 of file pdf_thread.cpp.

{
}

---

Member Function Documentation

bool pdf::Thread::abort_task	(	void *	user_data,
		TaskType	t,
		unsigned int	id
	)

Abort or remove a given task.

Definition at line 293 of file pdf_thread.cpp.

References pdf::Task::abort(), pdf::Task::get_id(), pdf::Task::get_type(), and pdf::Task::get_user_data().

Referenced by pdf::PDFController::abort_search().

{
    {
        ScopeMutex r(&running_task_mutex);
        if (running_task != 0 &&
            running_task->get_type() == t &&
            running_task->get_user_data() == user_data &&
            running_task->get_id() == id)
        {
            // if running task is the one, abort it
            running_task->abort();
            return true;
        }
    }

    // search the task in queue
    ScopeMutex m(&queue_mutex);
    TaskQueueIter idx = task_queue.begin();
    while (idx != task_queue.end())
    {
        if ((*idx)->get_type() == t &&
            (*idx)->get_user_data() == user_data &&
            (*idx)->get_id() == id)
        {
            delete *idx;
            task_queue.erase(idx);
            return true;
        }
        idx++;
    }

    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool pdf::Thread::append_task

(

Task *

new_task

)

Append the task to the end of the task queue.

Definition at line 204 of file pdf_thread.cpp.

References pdf::Cond::signal().

Referenced by pdf::PDFLibrary::thread_add_render_task().

{
    if (thread_cmd == CMD_NONE)
    {
        // Append task to the end of the task queue.
        {
            ScopeMutex m(&queue_mutex);
            task_queue.push_back(new_task);
        }

        // Tells the worker thread that a new task is available.
        queue_cond.signal();
        return true;
    }

    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void pdf::Thread::cancel_tasks

(

void *

user_data = 0

)

Cancel all of the tasks including current one.

Parameters:

user_data

if this value is not null, thread will clear all of the tasks with this value.

Definition at line 107 of file pdf_thread.cpp.

References clear_all(), and pdf::Task::get_user_data().

Referenced by pdf::PDFLibrary::remove_tasks_by_document().

{
    clear_all(user_data);

    ScopeMutex r(&running_task_mutex);
    if (running_task != 0 &&
        running_task->get_user_data() == user_data)
    {
        running_task->abort_and_wait(cancel_task_mutex);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void pdf::Thread::clear_all	(	void *	user_data = 0,
		TaskType	t = TASK_INVALID
	)

Remove all tasks in the task queue.

Definition at line 119 of file pdf_thread.cpp.

References pdf::TASK_INVALID.

Referenced by cancel_tasks(), stop(), and pdf::PDFLibrary::thread_cancel_render_tasks().

{
    ScopeMutex m(&queue_mutex);

    TaskQueueIter idx = task_queue.begin();
    while (idx != task_queue.end())
    {
        bool is_remove = false;
        if (user_data == 0)
        {
            is_remove = true;
        }
        else if (user_data == (*idx)->get_user_data())
        {
            if (t == TASK_INVALID || (t == (*idx)->type))
            {
                is_remove = true;
            }
        }

        if (is_remove)
        {
            delete *idx;
            idx = task_queue.erase(idx);
        }
        else
        {
            idx++;
        }
    }

    if (user_data == 0)
    {
        task_queue.clear();
    }
}

Here is the caller graph for this function:

bool pdf::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 222 of file pdf_thread.cpp.

References pdf::Cond::signal().

Referenced by pdf::PDFLibrary::thread_add_render_task(), and pdf::PDFLibrary::thread_add_search_task().

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

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

        if (abort_current)
        {
            abort_current_task(new_task);
        }

        return true;
    }

    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool pdf::Thread::start

(

)

Run thread.

Definition at line 156 of file pdf_thread.cpp.

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

    // Reset the thread cmd. TODO: Replace this variable by a boolean.
    thread_cmd = CMD_NONE;
    
    thread = g_thread_create(thread_func, this, TRUE, NULL);
    return thread != NULL;
}

void pdf::Thread::stop

(

bool

cancel_all_tasks = true

)

Stop current thread.

TODO, still a problem here. running task must be associated with document. Can not use cancle all tasks directly.

Definition at line 173 of file pdf_thread.cpp.

References clear_all(), and pdf::Cond::signal().

Referenced by pdf::PDFLibrary::~PDFLibrary().

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

    thread_cmd = cancel_all_tasks ? CMD_TERMINATE : CMD_STOP;

    {
        ScopeMutex r(&running_task_mutex);
        if (running_task != 0)
        {
            if (cancel_all_tasks)
            {
                running_task->abort_and_wait(cancel_task_mutex);
            }
        }
    }

    queue_cond.signal();

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

    clear_all();

    // Set the thread to be NULL
    thread = NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• pdf_thread.h
• pdf_thread.cpp