knowrob::ThreadPool::Worker Class Reference

#include <ThreadPool.h>

Collaboration diagram for knowrob::ThreadPool::Worker:

Public Member Functions
	Worker (ThreadPool *thread_pool)
	~Worker ()
	Worker (const Worker &)=delete
	Worker (ThreadPool *thread_pool)
	~Worker ()
	Worker (const Worker &)=delete

Protected Member Functions
void	run ()
void	run ()

Protected Attributes
ThreadPool *	threadPool_
std::atomic< bool >	isTerminated_
std::atomic< bool >	hasTerminateRequest_
std::thread	thread_

Friends
class	ThreadPool

Detailed Description

A worker thread that pulls work goals from the work queue of a thread pool.

Definition at line 65 of file ThreadPool.h.

Constructor & Destructor Documentation

Worker() [1/4]

ThreadPool::Worker::Worker ( ThreadPool *  thread_pool )

explicit

Definition at line 101 of file ThreadPool.cpp.

        : threadPool_(threadPool),
          isTerminated_(false),
          hasTerminateRequest_(false),
          thread_(&Worker::run, this) {
}

~Worker() [1/2]

ThreadPool::Worker::~Worker

(

)

Definition at line 108 of file ThreadPool.cpp.

                          {
    hasTerminateRequest_ = true;
    if (thread_.joinable()) thread_.join();
}

Worker() [2/4]

knowrob::ThreadPool::Worker::Worker ( const Worker &  )

delete

Cannot be copy-assigned.

Worker() [3/4]

knowrob::ThreadPool::Worker::Worker ( ThreadPool *  thread_pool )

explicit

~Worker() [2/2]

knowrob::ThreadPool::Worker::~Worker

(

)

Worker() [4/4]

knowrob::ThreadPool::Worker::Worker ( const Worker &  )

delete

Cannot be copy-assigned.

Member Function Documentation

run() [1/2]

void ThreadPool::Worker::run ( )

protected

Definition at line 113 of file ThreadPool.cpp.

                           {
    KB_DEBUG("Worker started.");
    // let the pool do some thread specific initialization
    if (!threadPool_->initializeWorker()) {
        KB_ERROR("Worker initialization failed.");
        isTerminated_ = true;
        threadPool_->numFinishedThreads_ += 1;
        return;
    }
    threadPool_->numActiveWorker_ += 1;
 
    // loop until the application exits
    while (!hasTerminateRequest_) {
        // wait for a claim
        {
            std::unique_lock<std::mutex> lk(threadPool_->workMutex_);
            threadPool_->numActiveWorker_ -= 1;
            if (!hasTerminateRequest_) {
                threadPool_->workCV_.wait(lk, [this] {
                    return hasTerminateRequest_ || !threadPool_->workQueue_.empty();
                });
            }
            threadPool_->numActiveWorker_ += 1;
        }
        if (hasTerminateRequest_) {
            break;
        }
 
        // pop work from queue
        auto goal = threadPool_->popWork();
        // do the work
        if (goal) {
            goal->runInternal();
        }
    }
 
    isTerminated_ = true;
    // tell the thread pool that a worker thread exited
    if (threadPool_->finalizeWorker_) {
        threadPool_->finalizeWorker_();
    }
    // note: counter indicates that there are finished threads in workerThreads_ list.
    threadPool_->numFinishedThreads_ += 1;
    threadPool_->numActiveWorker_ -= 1;
    KB_DEBUG("Worker terminated.");
}

run() [2/2]

void knowrob::ThreadPool::Worker::run ( )

protected

Friends And Related Function Documentation

ThreadPool

ThreadPool

friend

Definition at line 86 of file ThreadPool.h.

Member Data Documentation

hasTerminateRequest_

std::atomic< bool > knowrob::ThreadPool::Worker::hasTerminateRequest_

protected

Definition at line 80 of file ThreadPool.h.

isTerminated_

std::atomic< bool > knowrob::ThreadPool::Worker::isTerminated_

protected

Definition at line 79 of file ThreadPool.h.

thread_

std::thread knowrob::ThreadPool::Worker::thread_

protected

Definition at line 82 of file ThreadPool.h.

threadPool_

ThreadPool * knowrob::ThreadPool::Worker::threadPool_

protected

Definition at line 77 of file ThreadPool.h.

---

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

• build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/ThreadPool.h
• src/ThreadPool.cpp