Forked version of CTPL Thread pool library
- The library was not maintained for some time
- Need simple library for thread pooling
- When I want to restart thread pool after the stop operation, there is no function for that and init function is private
- Want to target that only for STL not maintaining both boost and STL version, boost version will be removed
- Target architecture for testing will be GCC 6/8 on Linux
A thread pool is a programming pattern for parallel execution of jobs, https://en.wikipedia.org/wiki/Thread_pool_pattern.
More specifically, there are some threads dedicated to the pool and a container of jobs. The jobs come to the pool dynamically. A job is fetched and deleted from the container when there is an idle thread. The job is then run on that thread.
A thread pool is helpful when you want to minimize time of loading and destroying threads and when you want to limit the number of parallel jobs that run simultanuasly. For example, time consuming event handlers may be processed in a thread pool to make UI more responsive.
Features:
- standard c++ language, tested to compile on MS Visual Studio 2013 (2012?), gcc 4.8.2 and mingw 4.8.1(with posix threads)
- simple but effiecient solution, one header only, no need to compile a binary library
- query the number of idle threads and resize the pool dynamically
- one API to push to the thread pool any collable object: lambdas, functors, functions, result of bind expression
- collable objects with variadic number of parameters plus index of the thread running the object
- automatic template argument deduction
- get returned value of any type with standard c++ futures
- get fired exceptions with standard C++ futures
- use for any purpose under Apache license
- Put the FTPL directory into your include directories, example cmake integration
include_directories(${CMAKE_SOURCE_DIR}/submodules/FTPL)
- Write your code
#include "ftpl.h"
uint32_t threads = 10;
template <typename T>
void zeroth(int ftpl_id, T a, T b)
{
//Do something with a and b
}
void first(int id)
{
std::cout << "hello from " << id << '\n';
};
struct Second
{
void operator()(int id) const
{
std::cout << "hello from " << id << '\n';
}
} second;
void third(int id, const std::string & additional_param) {}
int main ()
{
ftpl::thread_pool* threadpool = nullptr;
if(threads != 0)
{
threadpool = new ftpl::thread_pool(threads);
}
if(threadpool != nullptr)
{
threadpool->push(first); // function
threadpool->push(third, "additional_param");
//Make barrier here
threadpool->stop(true);
threadpool->init();
threadpool->push( (int id)
{
std::cout << "hello from " << id << '\n';
}); // lambda
threadpool->push(std::ref(second)); // functor, reference
threadpool->push(const_cast const Second (second)); // functor, copy ctor
threadpool->push(std::move(second)); // functor, move ctor
threadpool->push(zeroth<float>, 1.0f, 0.0f);
} else
{
//This is contraintuitive
int dummy_ftpl_id=0;
zeroth<float>(dummy_ftpl_id, 1.0f, 0.0f);
}
if(threadpool != nullptr)
{
threadpool->stop(true);
delete threadpool;
}
}