src/lib/signal_manager.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   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, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef DCPOMATIC_SIGNAL_MANAGER_H
  21 #define DCPOMATIC_SIGNAL_MANAGER_H
  22
  23 #include <boost/bind.hpp>
  24 #include <boost/asio.hpp>
  25 #include <boost/thread.hpp>
  26
  27 class Signaller;
  28
  29 /** A class to allow signals to be emitted from non-UI threads and handled
  30  *  by a UI thread.
  31  */
  32 class SignalManager : public boost::noncopyable
  33 {
  34 public:
  35         /** Create a SignalManager.  Must be called from the UI thread */
  36         SignalManager ()
  37                 : _work (_service)
  38         {
  39                 _ui_thread = boost::this_thread::get_id ();
  40         }
  41
  42         /* Do something next time the UI is idle */
  43         template <typename T>
  44         void when_idle (T f) {
  45                 _service.post (f);
  46         }
  47
  48         /** Call this in the UI when it is idle */
  49         size_t ui_idle () {
  50                 /* This executes any functors that have been post()ed to _service */
  51                 return _service.poll ();
  52         }
  53
  54         /** This should wake the UI and make it call ui_idle() */
  55         virtual void wake_ui () {
  56                 /* This is only a sensible implementation when there is no GUI */
  57                 ui_idle ();
  58         }
  59
  60 private:
  61         /** Emit a signal from any thread whose handlers will be called in the UI
  62          *  thread.  Use something like:
  63          *
  64          *  ui_signaller->emit (boost::bind (boost::ref (SomeSignal), parameter));
  65          */
  66         template <typename T>
  67         void emit (T f) {
  68                 if (boost::this_thread::get_id() == _ui_thread) {
  69                         /* already in the UI thread */
  70                         f ();
  71                 } else {
  72                         /* non-UI thread; post to the service and wake up the UI */
  73                         _service.post (f);
  74                         wake_ui ();
  75                 }
  76         }
  77
  78         friend class Signaller;
  79
  80         /** A io_service which is used as the conduit for messages */
  81         boost::asio::io_service _service;
  82         /** Object required to keep io_service from stopping when it has nothing to do */
  83         boost::asio::io_service::work _work;
  84         /** The UI thread's ID */
  85         boost::thread::id _ui_thread;
  86 };
  87
  88 extern SignalManager* signal_manager;
  89
  90 #endif