EventThread.h

Go to the documentation of this file.

// This file is part of CoreLibrary containing useful reusable utility
// classes.
//
// Copyright (C) 2014 to present, Duncan Crutchley
// Contact <dac1976github@outlook.com>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License and GNU Lesser General Public License
// for more details.
//
// You should have received a copy of the GNU General Public License
// and GNU Lesser General Public License along with this program. If
// not, see <http://www.gnu.org/licenses/>.

#ifndef EVENTTHREAD_H
#define EVENTTHREAD_H

#include <functional>
#include "Threads/ThreadBase.h"
#include "Threads/SyncEvent.h"

namespace core_lib
{
namespace threads
{

class CORE_LIBRARY_DLL_SHARED_API EventThread final : public core_lib::threads::ThreadBase
{
    using event_callback_t = std::function<void()>;

public:
    EventThread(event_callback_t const& eventCallback, unsigned int eventPeriodMillisecs,
                bool delayedStart = false);

    ~EventThread() override;

    EventThread(const EventThread&) = delete;
    EventThread& operator=(const EventThread&) = delete;
    EventThread(EventThread&&) = delete;
    EventThread& operator=(EventThread&&) = delete;

    void EventPeriod(unsigned int eventPeriodMillisecs);
    unsigned int EventPeriod() const;

    void ForceTick();

private:
    void ThreadIteration() NO_EXCEPT_ override;
    void ProcessTerminationConditions() NO_EXCEPT_ override;

private:
    mutable std::mutex m_eventTickMutex;
    core_lib::threads::SyncEvent m_updateEvent{};
    event_callback_t m_eventCallback{};
    unsigned int m_eventPeriodMillisecs{0};
};

} // namespace threads
} // namespace core_lib

#endif // EVENTTHREAD_H