PPI/IntervalTimer.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief IntervalTimer public header */
  25
  26 #ifndef HH_IntervalTimer_
  27 #define HH_IntervalTimer_ 1
  28
  29 // Custom includes
  30 #include "Scheduler/ClockService.hh"
  31 #include "Events.hh"
  32
  33 //#include "IntervalTimer.mpp"
  34 ///////////////////////////////hh.p////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace ppi {
  38
  39     struct IntervalTimerEventInfo
  40     {
  41         ClockService::clock_type expected;
  42         ClockService::clock_type intervalStart;
  43         unsigned number;
  44     };
  45
  46     /** \brief
  47       */
  48     class IntervalTimer
  49         : public EventImplementation<IntervalTimerEventInfo>
  50     {
  51     public:
  52         ///////////////////////////////////////////////////////////////////////////
  53         // Types
  54
  55         ///////////////////////////////////////////////////////////////////////////
  56         ///\name Structors and default members
  57         ///@{
  58
  59         explicit IntervalTimer(ClockService::clock_type interval,
  60                                unsigned eventsPerInterval=1);
  61
  62         ///@}
  63         ///////////////////////////////////////////////////////////////////////////
  64
  65     protected:
  66
  67     private:
  68         virtual void v_enable();
  69         virtual void v_disable();
  70
  71         void schedule();
  72         void cb();
  73
  74         ClockService::clock_type interval_;
  75         unsigned eventsPerInterval_;
  76         IntervalTimerEventInfo info_;
  77         unsigned id_;
  78     };
  79
  80 }}
  81
  82 ///////////////////////////////hh.e////////////////////////////////////////
  83 #include "IntervalTimer.cci"
  84 //#include "IntervalTimer.ct"
  85 //#include "IntervalTimer.cti"
  86 #endif
  87
  88 \f
  89 // Local Variables:
  90 // mode: c++
  91 // fill-column: 100
  92 // comment-column: 40
  93 // c-file-style: "senf"
  94 // indent-tabs-mode: nil
  95 // ispell-local-dictionary: "american"
  96 // compile-command: "scons -u test"
  97 // End: