ThreadBase.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 THREADBASE
#define THREADBASE

#include <thread>
#include <mutex>
#include "CoreLibraryDllGlobal.h"
#include "Platform/PlatformDefines.h"

namespace core_lib
{
namespace threads
{

class CORE_LIBRARY_DLL_SHARED_API ThreadBase
{
public:
    ThreadBase(const ThreadBase&) = delete;
    ThreadBase& operator=(const ThreadBase&) = delete;
    ThreadBase(ThreadBase&&) = default;
    ThreadBase& operator=(ThreadBase&&) = default;
    virtual ~ThreadBase() = default;
    bool IsStarted() const;
    bool Start();
    bool Stop();
    std::thread::id ThreadID() const;
    std::thread::native_handle_type NativeHandle() const;

protected:
    ThreadBase() = default;
    void SetTerminating(bool terminating = true);
    bool IsTerminating() const;
    void SleepForTime(unsigned int milliSecs) const;
    virtual void ThreadIteration() NO_EXCEPT_ = 0;
    virtual void ProcessTerminationConditions() NO_EXCEPT_;

private:
    void SetThreadIdAndNativeHandle(const std::thread::id&                 threadId,
                                    const std::thread::native_handle_type& nativeHandle);
    void SetStarted(bool started = true);
    void Run();

private:
    mutable std::mutex m_mutex;
    bool m_started{false};
    bool m_terminating{false};
    std::thread::id m_threadId{};
    std::thread::native_handle_type m_nativeHandle{};
    std::thread m_thread{};
};

} // namespace threads
} // namespace core_lib

#endif // THREADBASE