SyncEvent.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 SYNCEVENT
#define SYNCEVENT

#include "CoreLibraryDllGlobal.h"
#include <mutex>
#include <condition_variable>

namespace core_lib
{
namespace threads
{

enum class eResetCondition
{
    manualReset,
    autoReset
};

enum class eNotifyType
{
    signalOneThread,
    signalAllThreads
};

enum class eIntialCondition
{
    notSignalled,
    signalled
};

class CORE_LIBRARY_DLL_SHARED_API SyncEvent final
{
public:
    SyncEvent() = default;
    SyncEvent(eNotifyType notifyCondition, eResetCondition resetCondition,
              eIntialCondition initialCondition);
    ~SyncEvent() = default;
    SyncEvent(const SyncEvent&) = delete;
    SyncEvent& operator=(const SyncEvent&) = delete;
    SyncEvent(SyncEvent&&) = delete;
    SyncEvent& operator=(SyncEvent&&) = delete;
    void Wait();
    bool WaitForTime(size_t milliseconds);
    void Signal();
    void Reset();

private:
    mutable std::mutex m_signalMutex;
    std::condition_variable m_signalCondVar;
    bool m_signalAllThreads{false};
    bool m_autoReset{true};
    bool m_signalFlag{false};
};

} // namespace threads
} // namespace core_lib

#endif // SYNCEVENT