mostlyharmless_TaskThread.h

Go to the documentation of this file.

//
// Created by Syl on 12/08/2024.
//
 
#ifndef MOSTLYHARMLESS_MOSTLYHARMLESS_TASKTHREAD_H
#define MOSTLYHARMLESS_MOSTLYHARMLESS_TASKTHREAD_H
#include <functional>
#include <atomic>
#include <mutex>
#include <thread>
 
namespace mostly_harmless::utils {
    /***
     * \brief Convenience wrapper around std::thread
     *
     * Contains some simple signalling mechanisms, and forms the basis for `Timer` - to use it, supply a lambda to the `action` field, then call perform (and remember to call `stop` to join the thread!)
     */
    class TaskThread {
    public:
        ~TaskThread() noexcept;

        auto perform() -> void;

        auto stop() noexcept -> void;

        auto sleep() -> void;

        auto wake() -> void;

        auto signalStop() -> void;

        [[nodiscard]] auto hasSignalledStop() const noexcept -> bool;

        [[nodiscard]] auto isThreadRunning() const noexcept -> bool;

        std::function<void(void)> action{ nullptr };
 
    private:
        auto reset() -> void;
        struct {
            std::mutex mutex;
            std::atomic<bool> canWakeUp{ false };
            std::condition_variable conditionVariable;
        } m_sleepState;
        std::atomic<bool> m_isThreadRunning{ false };
        std::atomic<bool> m_stop{ false };
        std::unique_ptr<std::thread> m_thread{ nullptr };
    };
} // namespace mostly_harmless::utils
#endif // MOSTLYHARMLESS_MOSTLYHARMLESS_TASKTHREAD_H