ThreadPool class
#include <slang/util/ThreadPool.h>
A lightweight thread pool for running concurrent jobs.
Constructors, destructors, conversion operators
- ThreadPool(unsigned threadCount = 0) explicit
- Constructs a new ThreadPool.
- ~ThreadPool()
- Destroys the thread pool, blocking until all threads have exited.
Public functions
-
template<typename TFunc, typename... TArgs>void pushTask(TFunc&& task, TArgs && ... args)
- Pushes a new task into the pool for execution.
-
template<typename TFunc, typename... TArgs, typename TResult = std::invoke_result_t<std::decay_t<TFunc>, std::decay_t<TArgs>...>>auto submit(TFunc&& task, TArgs && ... args) -> std::future<TResult>
- Submits a task into the pool for execution and returns a future for tracking completion.
- void waitForAll()
- Blocks the calling thread until all running tasks are complete.
Function documentation
slang::
Constructs a new ThreadPool.
| Parameters | |
|---|---|
| threadCount | The number of threads to create in the pool. If zero (the default) the number of threads will be set to the number of concurrent threads supported by the system. |
template<typename TFunc, typename... TArgs>
void slang::
Pushes a new task into the pool for execution.
There is no way to wait for the pushed task to complete aside from calling waitForAll and waiting for all tasks in the pool to complete.
template<typename TFunc, typename... TArgs, typename TResult = std::invoke_result_t<std::decay_t<TFunc>, std::decay_t<TArgs>...>>
std::future<TResult> slang::
Submits a task into the pool for execution and returns a future for tracking completion.
| Returns | A std::future that will eventually contain the result of the task. |
|---|