clanguml::util::thread_pool_executor Class Reference

Simple thread pool executor for parallelizing diagram generation. More...

Detailed Description

Simple thread pool executor for parallelizing diagram generation.

Definition at line 30 of file thread_pool_executor.h.

#include <thread_pool_executor.h>

Public Member Functions
	thread_pool_executor (unsigned int pool_size)
	Constructor.
	thread_pool_executor (const thread_pool_executor &)=delete
	thread_pool_executor (thread_pool_executor &&)=delete
thread_pool_executor &	operator= (const thread_pool_executor &)=delete
thread_pool_executor &	operator= (thread_pool_executor &&)=delete
	~thread_pool_executor ()
std::future< void >	add (std::function< void()> &&task)
	Add a task to run on the pool.
void	stop ()
	Join all active threads in the pool.

Private Member Functions
void	worker ()
	Main worker pool thread method - take task from queue and execute.
std::packaged_task< void()>	get ()

Private Attributes
std::atomic_bool	done_
std::deque< std::packaged_task< void()> >	tasks_
std::mutex	tasks_mutex_
std::condition_variable	tasks_cond_
std::vector< std::thread >	threads_

Constructor & Destructor Documentation

thread_pool_executor() [1/3]

clanguml::util::thread_pool_executor::thread_pool_executor ( unsigned int  pool_size )

explicit

Constructor.

Parameters

pool_size

Number of threads in the pool

Definition at line 23 of file thread_pool_executor.cc.

    : done_{false}
{
    if (pool_size == 0U)
        pool_size = std::thread::hardware_concurrency();
 
    for (auto i = 0U; i < pool_size; i++) {
        threads_.emplace_back(&thread_pool_executor::worker, this);
    }
}

thread_pool_executor() [2/3]

clanguml::util::thread_pool_executor::thread_pool_executor ( const thread_pool_executor &  )

delete

thread_pool_executor() [3/3]

clanguml::util::thread_pool_executor::thread_pool_executor ( thread_pool_executor &&  )

delete

~thread_pool_executor()

clanguml::util::thread_pool_executor::~thread_pool_executor

(

)

Definition at line 34 of file thread_pool_executor.cc.

{ stop(); }

Member Function Documentation

add()

std::future< void > clanguml::util::thread_pool_executor::add

(

std::function< void()> &&

task

)

Add a task to run on the pool.

Parameters

task	Function to execute

Returns

Future, allowing awaiting the result

Definition at line 36 of file thread_pool_executor.cc.

{
    std::unique_lock<std::mutex> l(tasks_mutex_);
 
    std::packaged_task<void()> ptask{std::move(task)};
    auto res = ptask.get_future();
 
    tasks_.emplace_back(std::move(ptask));
 
    l.unlock();
    tasks_cond_.notify_one();
 
    return res;
}

get()

std::packaged_task< void()> clanguml::util::thread_pool_executor::get ( )

private

Definition at line 73 of file thread_pool_executor.cc.

{
    std::unique_lock<std::mutex> l(tasks_mutex_);
 
    while (tasks_.empty()) {
        if (done_)
            throw std::runtime_error("Thread pool closing...");
 
        tasks_cond_.wait_for(l, std::chrono::seconds(1));
    }
 
    auto res = std::move(tasks_.front());
    tasks_.pop_front();
    return res;
}

operator=() [1/2]

thread_pool_executor & clanguml::util::thread_pool_executor::operator= ( const thread_pool_executor &  )

delete

operator=() [2/2]

thread_pool_executor & clanguml::util::thread_pool_executor::operator= ( thread_pool_executor &&  )

delete

stop()

void clanguml::util::thread_pool_executor::stop

(

)

Join all active threads in the pool.

Definition at line 51 of file thread_pool_executor.cc.

{
    done_ = true;
    for (auto &thread : threads_) {
        if (thread.joinable())
            thread.join();
    }
}

worker()

void clanguml::util::thread_pool_executor::worker ( )

private

Main worker pool thread method - take task from queue and execute.

Definition at line 60 of file thread_pool_executor.cc.

{
    try {
        while (!done_) {
            auto task = get();
 
            task();
        }
    }
    catch (std::runtime_error &e) {
    }
}

Member Data Documentation

done_

std::atomic_bool clanguml::util::thread_pool_executor::done_

private

Definition at line 67 of file thread_pool_executor.h.

tasks_

std::deque<std::packaged_task<void()> > clanguml::util::thread_pool_executor::tasks_

private

Definition at line 68 of file thread_pool_executor.h.

tasks_cond_

std::condition_variable clanguml::util::thread_pool_executor::tasks_cond_

private

Definition at line 70 of file thread_pool_executor.h.

tasks_mutex_

std::mutex clanguml::util::thread_pool_executor::tasks_mutex_

private

Definition at line 69 of file thread_pool_executor.h.

threads_

std::vector<std::thread> clanguml::util::thread_pool_executor::threads_

private

Definition at line 71 of file thread_pool_executor.h.

---

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

• src/util/thread_pool_executor.h
• src/util/thread_pool_executor.cc