summaryrefslogtreecommitdiff
path: root/src/lib/checker.h
blob: fee3fc3d92595aaa4deb01fdd93fbdecb2a681d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
    Copyright (C) 2018 Carl Hetherington <cth@carlh.net>

    This file is part of DCP-o-matic.

    DCP-o-matic 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.

    DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.

*/

/** @file  src/lib/checker.h
 *  @brief Checker class.
 */

#ifndef DCPOMATIC_CHECKER_H
#define DCPOMATIC_CHECKER_H

#include "signaller.h"
#include <boost/signals2.hpp>

/** Parent for classes which check some condition every so often and signal
 *  when the state of the condition changes.
 */
class Checker : public Signaller, public boost::noncopyable
{
public:
	virtual ~Checker ();

	void run ();

	bool ok () const;

	/** Emitted when the state of our condition changes */
	boost::signals2::signal<void (void)> StateChanged;

protected:

	Checker (int period);

	/** @return true if the condition is `ok', otherwise false */
	virtual bool check () const = 0;

private:

	void thread ();

	boost::thread* _thread;
	mutable boost::mutex _mutex;
	bool _terminate;
	bool _ok;
	/** check period in seconds */
	int _period;
};

#endif