source: source/ariba/utility/system/Timer.h@ 4835

Last change on this file since 4835 was 4828, checked in by Christoph Mayer, 15 years ago

timer reset function

File size: 3.3 KB
Line 
1// [License]
2// The Ariba-Underlay Copyright
3//
4// Copyright (c) 2008-2009, Institute of Telematics, UniversitÀt Karlsruhe (TH)
5//
6// Institute of Telematics
7// UniversitÀt Karlsruhe (TH)
8// Zirkel 2, 76128 Karlsruhe
9// Germany
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``AS IS'' AND
22// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARIBA PROJECT OR
25// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32//
33// The views and conclusions contained in the software and documentation
34// are those of the authors and should not be interpreted as representing
35// official policies, either expressed or implied, of the Institute of
36// Telematics.
37// [License]
38
39#ifndef __TIMER_H
40#define __TIMER_H
41
42#include "ariba/utility/system/SystemEventListener.h"
43#include "ariba/utility/system/SystemQueue.h"
44#include "ariba/utility/system/SystemEvent.h"
45#include "ariba/utility/system/SystemEventType.h"
46#include "ariba/utility/logging/Logging.h"
47
48#ifndef UNDERLAY_OMNET
49 #include <boost/thread/mutex.hpp>
50 #include <boost/thread/thread.hpp>
51 #include <boost/thread/condition_variable.hpp>
52#endif
53
54using ariba::utility::SystemEventType;
55using ariba::utility::SystemQueue;
56using ariba::utility::SystemEventListener;
57
58namespace ariba {
59namespace utility {
60
61class Timer : public SystemEventListener {
62 use_logging_h(Timer);
63public:
64 Timer();
65 ~Timer();
66
67 /**
68 * Set the interval for the timer
69 *
70 * @param millis Timer interval in milliseconds
71 * @param oneshot Is this a one-shot or periodic timer
72 */
73 void setInterval(unsigned int millis, bool oneshot=false);
74
75 /**
76 * Start the timer
77 */
78 void start();
79
80 /**
81 * Stop the timer
82 */
83 void stop();
84
85 /**
86 * Reset a running timer and ignore the remaining interval
87 * time. Start the timer with a new timer interval.
88 */
89 void reset();
90
91protected:
92 virtual void eventFunction();
93
94protected:
95 virtual void handleSystemEvent( const SystemEvent& event );
96
97private:
98#ifndef UNDERLAY_OMNET
99 static void threadFunc( Timer* obj );
100 boost::thread* timerThread;
101#endif // UNDERLAY_OMNET
102
103 volatile unsigned int millis;
104 volatile bool running;
105 volatile bool oneshot;
106};
107
108}} // namespace ariba, common
109
110#endif // __TIMER_H
Note: See TracBrowser for help on using the repository browser.