git.maemo.org Git - lordsawar/blob - src/timing.h

   1 //  Copyright (C) 2007 Ole Laursen
   2 //
   3 //  This program is free software; you can redistribute it and/or modify
   4 //  it under the terms of the GNU General Public License as published by
   5 //  the Free Software Foundation; either version 3 of the License, or
   6 //  (at your option) any later version.
   7 //
   8 //  This program is distributed in the hope that it will be useful,
   9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 //  GNU Library General Public License for more details.
  12 //
  13 //  You should have received a copy of the GNU General Public License
  14 //  along with this program; if not, write to the Free Software
  15 //  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16 //  02110-1301, USA.
  17
  18 #ifndef TIMING_H
  19 #define TIMING_H
  20
  21 #include <sigc++/slot.h>
  22 #include <sigc++/connection.h>
  23 #include <sigc++/signal.h>
  24 #include <boost/noncopyable.hpp>
  25
  26 //! A simple timing framework.
  27 /**
  28   * Main function is register_timer. The timer_registered signal hook is used
  29   * to do the actual work.
  30   */
  31 class Timing: public boost::noncopyable
  32 {
  33  public:
  34     static Timing &instance();
  35     ~Timing();
  36
  37     enum { STOP = false, CONTINUE = true };
  38     typedef sigc::slot<bool> timer_slot;
  39
  40     // register a callback, returns a handle that can be used to disconnect the
  41     // timer - alternatively, return Timing::STOP
  42     sigc::connection register_timer(timer_slot s, int msecs_interval);
  43
  44     // the entity providing timing should hook into this to make things happen
  45     sigc::signal<sigc::connection, timer_slot, int> timer_registered;
  46
  47  private:
  48     Timing();
  49 };
  50
  51 #endif