src/lib/checker.h

   1 /*
   2     Copyright (C) 2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/lib/checker.h
  22  *  @brief Checker class.
  23  */
  24
  25 #ifndef DCPOMATIC_CHECKER_H
  26 #define DCPOMATIC_CHECKER_H
  27
  28 #include "signaller.h"
  29 #include <boost/signals2.hpp>
  30
  31 /** Parent for classes which check some condition every so often and signal
  32  *  when the state of the condition changes.
  33  */
  34 class Checker : public Signaller, public boost::noncopyable
  35 {
  36 public:
  37         virtual ~Checker ();
  38
  39         void run ();
  40
  41         bool ok () const;
  42
  43         /** Emitted when the state of our condition changes */
  44         boost::signals2::signal<void (void)> StateChanged;
  45
  46 protected:
  47
  48         Checker (int period);
  49
  50         /** @return true if the condition is `ok', otherwise false */
  51         virtual bool check () const = 0;
  52
  53 private:
  54
  55         void thread ();
  56
  57         boost::thread* _thread;
  58         mutable boost::mutex _mutex;
  59         bool _terminate;
  60         bool _ok;
  61         /** check period in seconds */
  62         int _period;
  63 };
  64
  65 #endif