timerthread.h

Go to the documentation of this file.

#pragma once

#include "threadex.h"
#include <atomic>
#include <mutex>
#include <functional>
#include <condition_variable>
#include <optional>

BEGIN_NAMESPACE_THREADING
enum class TimerMode : int
{
    FixedDelay = 0,
    FixedRate = 1
};

class TimerThread : public ThreadEx
{
public:
    using CallbackFunction = std::function<void(void)>;

    TimerThread(int intervalMs = 1000, CallbackFunction callback = nullptr, int delayMs = -1, TimerMode timerMode = TimerMode::FixedDelay);

    TimerThread(std::chrono::microseconds interval, CallbackFunction callback = nullptr, std::optional<std::chrono::microseconds> delay = std::nullopt, TimerMode timerMode = TimerMode::FixedDelay);

    ~TimerThread() override;

    void start() override;

    void stop() override;

    int getIntervalMs() const;

    int getIntervalMcs() const;

    void setIntervalMs(const int value);

    void setIntervalMcs(const int value);

    int getDelayMs() const;

    int getDelayMcs() const;

    void setDelayMs(const int value);

    void setDelayMcs(const int value);

    void setTimerMode(TimerMode timerMode);

    TimerMode getTimerMode() const;

    CallbackFunction& getCallback();

    void setCallback(const CallbackFunction& value);

    int64_t getNoOfCallbacks() const;

protected:
    void execute() override;
    virtual void executeTimerCallback();

private:
    std::mutex terminateMutex;
    std::condition_variable doTerminate;
    std::atomic<int64_t> noOfCallbacks{0};
    std::atomic<std::chrono::microseconds> intervalMcs;
    std::atomic<std::chrono::microseconds> delayMcs;
    TimerMode timerMode;
    CallbackFunction callback;
};

END_NAMESPACE_THREADING