4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief IntervalTimer public header */
26 #ifndef HH_SENF_PPI_IntervalTimer_
27 #define HH_SENF_PPI_IntervalTimer_ 1
30 #include "../Scheduler/ClockService.hh"
33 //#include "IntervalTimer.mpp"
34 ///////////////////////////////hh.p////////////////////////////////////////
39 /** \brief IntervalTimer event information
41 Information passed to the IntervalTimer event handler
43 struct IntervalTimerEventInfo
45 ClockService::clock_type expected; ///< Scheduled event time
46 ClockService::clock_type intervalStart; ///< Start of the current time interval
47 unsigned number; ///< Number of the current event within the interval
50 /** \brief High precision regularly signaled event.
52 An IntervalTimer signals an event \a eventsPerInterval times each \a interval
53 nanoseconds. The event counter and timer are reset, whenever the event is disabled.
55 \see IntervalTimerEventInfo
60 : public EventImplementation<IntervalTimerEventInfo>
63 ///////////////////////////////////////////////////////////////////////////
64 ///\name Structors and default members
67 explicit IntervalTimer(ClockService::clock_type interval,
68 unsigned eventsPerInterval=1);
72 ///////////////////////////////////////////////////////////////////////////
74 void interval(ClockService::clock_type interval, unsigned eventsPerInterval=1);
75 std::pair<ClockService::clock_type, unsigned> interval() const;
80 virtual void v_enable();
81 virtual void v_disable();
86 ClockService::clock_type interval_;
87 unsigned eventsPerInterval_;
88 IntervalTimerEventInfo info_;
89 scheduler::TimerEvent timer_;
94 ///////////////////////////////hh.e////////////////////////////////////////
95 #include "IntervalTimer.cci"
96 //#include "IntervalTimer.ct"
97 //#include "IntervalTimer.cti"
104 // comment-column: 40
105 // c-file-style: "senf"
106 // indent-tabs-mode: nil
107 // ispell-local-dictionary: "american"
108 // compile-command: "scons -u test"