senf/PPI/IntervalTimer.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   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_SENF_PPI_IntervalTimer_
  27 #define HH_SENF_PPI_IntervalTimer_ 1
  28
  29 // Custom includes
  30 #include <senf/Scheduler/ClockService.hh>
  31 #include <senf/Scheduler/TimerEvent.hh>
  32 #include "Events.hh"
  33
  34 //#include "IntervalTimer.mpp"
  35 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  36
  37 namespace senf {
  38 namespace ppi {
  39
  40     /** \brief IntervalTimer event information
  41
  42         Information passed to the IntervalTimer event handler
  43      */
  44     struct IntervalTimerEventInfo
  45     {
  46         ClockService::clock_type expected; ///< Scheduled event time
  47         ClockService::clock_type intervalStart; ///< Start of the current time interval
  48         unsigned number;                ///< Number of the current event within the interval
  49     };
  50
  51     /** \brief High precision regularly signaled event.
  52
  53         An IntervalTimer signals an event \a eventsPerInterval times each \a interval
  54         nanoseconds. The event counter and timer are reset, whenever the event is disabled.
  55
  56         \see IntervalTimerEventInfo
  57
  58         \ingroup event_group
  59       */
  60     class IntervalTimer
  61         : public EventImplementation<IntervalTimerEventInfo>
  62     {
  63     public:
  64         //-////////////////////////////////////////////////////////////////////////
  65         ///\name Structors and default members
  66         //\{
  67
  68         explicit IntervalTimer(ClockService::clock_type interval,
  69                                unsigned eventsPerInterval=1);
  70         IntervalTimer();
  71
  72         //\}
  73         //-////////////////////////////////////////////////////////////////////////
  74
  75         void interval(ClockService::clock_type interval, unsigned eventsPerInterval=1);
  76         std::pair<ClockService::clock_type, unsigned> interval() const;
  77
  78     protected:
  79
  80     private:
  81         virtual void v_enable();
  82         virtual void v_disable();
  83
  84         void schedule();
  85         void cb();
  86
  87         ClockService::clock_type interval_;
  88         unsigned eventsPerInterval_;
  89         IntervalTimerEventInfo info_;
  90         scheduler::TimerEvent timer_;
  91     };
  92
  93 }}
  94
  95 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  96 #include "IntervalTimer.cci"
  97 //#include "IntervalTimer.ct"
  98 //#include "IntervalTimer.cti"
  99 #endif
 100
 101 \f
 102 // Local Variables:
 103 // mode: c++
 104 // fill-column: 100
 105 // comment-column: 40
 106 // c-file-style: "senf"
 107 // indent-tabs-mode: nil
 108 // ispell-local-dictionary: "american"
 109 // compile-command: "scons -u test"
 110 // End: