thread_ctrl.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2024 Alec Leamas                                        *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 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 for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,  USA.         *
 **************************************************************************/
 
#ifndef THREAD_CTRL_H__
#define THREAD_CTRL_H__
 
#include <condition_variable>
#include <mutex>
 
class ThreadCtrl {
public:
  ThreadCtrl() : m_keep_going(1) {}
 
  virtual ~ThreadCtrl() = default;
 
  bool IsRunning() const { return KeepGoing(); }
 
  virtual void RequestStop();
 
  void WaitUntilStopped();
 
  bool WaitUntilStopped(std::chrono::duration<int> timeout);
 
  bool WaitUntilStopped(std::chrono::duration<int> timeout,
                        std::chrono::milliseconds& elapsed);
 
protected:
  bool KeepGoing() const;
 
  void SignalExit();
 
private:
  mutable std::mutex m_mutex;
  std::condition_variable m_cv;
  int m_keep_going;
};
 
#endif  //  THREAD_CTRL_H__