OpenCPN Partial API docs
Loading...
Searching...
No Matches
thread_ctrl.h
Go to the documentation of this file.
1/***************************************************************************
2 * Copyright (C) 2024 Alec Leamas *
3 * *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, see <https://www.gnu.org/licenses/>. *
16 **************************************************************************/
17
24#ifndef THREAD_CTRL_H__
25#define THREAD_CTRL_H__
26
27#include <condition_variable>
28#include <mutex>
29
32public:
33 ThreadCtrl() : m_keep_going(1) {}
34
38 virtual ~ThreadCtrl() = default;
39
41 bool IsRunning() const { return KeepGoing(); }
42
44 virtual void RequestStop();
45
47 void WaitUntilStopped();
48
53 bool WaitUntilStopped(std::chrono::duration<int> timeout);
54
61 bool WaitUntilStopped(std::chrono::duration<int> timeout,
62 std::chrono::milliseconds& elapsed);
63
64protected:
66 bool KeepGoing() const;
67
69 void SignalExit();
70
71private:
72 mutable std::mutex m_mutex;
73 std::condition_variable m_cv;
74 int m_keep_going;
75};
76
77#endif // THREAD_CTRL_H__
Thread mixin providing a "stop thread"/"wait until stopped" interface.
Definition thread_ctrl.h:31
void WaitUntilStopped()
Block until thread invokes SignalExit().
bool IsRunning() const
Return true if thread is running.
Definition thread_ctrl.h:41
void SignalExit()
Signal that thread has exited.
virtual ~ThreadCtrl()=default
Destroy the Thread Ctrl object.
bool KeepGoing() const
If true continue thread operation, else exit and invoke SignalExit()
virtual void RequestStop()
Request that thread stops operation.