mirror of
https://github.com/YACReader/yacreader
synced 2025-05-25 18:00:46 -04:00
05b384ed6d
This member function does not affect the logical state of the class. Making std::condition_variable and std::mutex data members mutable is idiomatic as these classes are thread-safe synchronization primitives.
56 lines
1.8 KiB
C++
56 lines
1.8 KiB
C++
#ifndef CONCURRENT_QUEUE_H
|
|
#define CONCURRENT_QUEUE_H
|
|
|
|
#include <thread>
|
|
#include <mutex>
|
|
#include <functional>
|
|
#include <condition_variable>
|
|
#include <queue>
|
|
#include <vector>
|
|
|
|
namespace YACReader {
|
|
//! All functions in this class are thread-safe in the Qt documentation sense.
|
|
class ConcurrentQueue
|
|
{
|
|
public:
|
|
//! @brief Creates and starts executing @p threadCount worker threads.
|
|
//! @note ConcurrentQueue is unable to execute jobs if @p threadCount == 0.
|
|
explicit ConcurrentQueue(std::size_t threadCount);
|
|
|
|
//! Cancels all jobs that have not been picked up by worker threads yet,
|
|
//! waits for all worker threads to complete their jobs and joins them.
|
|
~ConcurrentQueue();
|
|
|
|
using Job = std::function<void()>;
|
|
|
|
//! @brief Adds @p job to the queue.
|
|
//! @note A worker thread may start executing @p job immediately if it is idle.
|
|
//! Worker threads start executing jobs in the same order as they are enqueued.
|
|
void enqueue(Job job);
|
|
|
|
//! @brief Cancels all jobs that have not been picked up by worker threads yet.
|
|
//! @return The number of jobs that were canceled.
|
|
std::size_t cancelPending();
|
|
|
|
//! @brief Blocks the current thread until all enqueued jobs are completed.
|
|
void waitAll() const;
|
|
|
|
private:
|
|
//! @invariant all worker threads are joinable until the destructor is called.
|
|
std::vector<std::thread> threads;
|
|
std::queue<Job> _queue;
|
|
std::size_t jobsLeft = 0; //!< @invariant jobsLeft >= _queue.size()
|
|
bool bailout = false; //!< @invariant is false until the destructor is called.
|
|
std::condition_variable jobAvailableVar;
|
|
mutable std::condition_variable _waitVar;
|
|
mutable std::mutex jobsLeftMutex;
|
|
std::mutex queueMutex;
|
|
|
|
void nextJob();
|
|
void finalizeJobs(std::size_t count);
|
|
};
|
|
|
|
}
|
|
|
|
#endif // CONCURRENT_QUEUE_H
|