ws_server/headers/task_queue.hpp

#include <atomic>
#include <condition_variable>
#include <functional>
#include <mutex>
#include <queue>
#include <thread>

/**
 * TaskQueue
 *
 * A task queue employs a pool of worker threads who can execute arbitrary tasks
 * @class
 */
class TaskQueue {
 public:
 /**
 * @constructor
 * Nothing fancy
 */
  TaskQueue();
/**
 * @destructor
 * Make sure all worker threads detach or join before destroying TaskQueue
 * instance
 */
  ~TaskQueue();

/** PUBLIC METHODS **/

/**
 * initialize
 *
 * To be called after an instance of TaskQueue is created.
 * @method
 */
  void initialize();
/**
 * pushToQueue
 *
 * Add a task to the queue
 *
 * @method
 * @param[in] {std::function<void()>} A fully encapsulated template function
 * with its own internal state
 */
  void pushToQueue(std::function<void()> fn);

 private:

/** PRIVATE METHODS **/
/**
 * workerLoop
 *
 * The loop is the essential lifecycle of the worker
 * @method
 */
  void workerLoop();
/**
 * deployWorkers
 *
 * Procures workers and sets them into existing by executing the workerLoop
 * function
 * @method
 */
  void deployWorkers();
/**
 * detachThreads
 *
 * Allows threads to terminate.
 * @method
 * @cleanup
 */
  void detachThreads();

/** PRIVATE MEMBERS **/

  /**
   * FIFO queue of templated function pointers
   */
  std::queue<std::function<void()>> m_task_queue;

  /**
   * vector of worker threads
   */
  std::vector<std::thread> m_thread_pool;

  /**
   * mutex for locking resources
   */
  std::mutex m_mutex_lock;
  /**
   * condition variable for controlling work execution
   */
  std::condition_variable pool_condition;
  /**
   * atomic boolean to ensure queue is handled in a thread-safe manner
   */
  std::atomic<bool> accepting_tasks;
};