EMANE  1.0.1
timerservice.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014,2016 - Adjacent Link LLC, Bridgewater,
3  * New Jersey
4  * Copyright (c) 2010-2012 - DRS CenGen, LLC, Columbia, Maryland
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  * * Neither the name of DRS CenGen, LLC nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef EMANETIMERSERVICE_HEADER_
36 #define EMANETIMERSERVICE_HEADER_
37 
38 #include "timerserviceexception.h"
39 #include "emane/timerserviceuser.h"
40 #include "emane/utils/singleton.h"
41 #include "emane/utils/timer.h"
42 
43 namespace EMANE
44 {
53  class TimerService : public Utils::Singleton<TimerService>
54  {
55  public:
61  bool cancelTimedEvent(TimerEventId eventId);
62 
63 
74  TimerEventId scheduleTimedEvent(const TimePoint & timePoint,
75  const void *arg,
76  const Duration & interval,
77  TimerServiceUser *pTimerServiceUser);
78 
79 
87  template <typename Function>
88  TimerEventId schedule(Function fn,
89  const TimePoint & timePoint,
90  const Duration & interval = Duration::zero());
91 
92 
93  protected:
94  TimerService() = default;
95 
96  private:
97  Utils::Timer timer_;
98  };
99 
101 }
102 
103 #include "timerservice.inl"
104 
105 #endif //EMANETIMERSERVICE_HEADER_
A timer class that uses Linux interval timers.
Definition: timer.h:54
Ensure a class only has one instance, and provide a global point of access to it. ...
Definition: singleton.h:47
bool cancelTimedEvent(TimerEventId eventId)
cancel a timed event
Definition: timerservice.cc:38
TimerServiceUser interface.
TimerService()=default
Clock::duration Duration
Definition: types.h:49
TimerEventId scheduleTimedEvent(const TimePoint &timePoint, const void *arg, const Duration &interval, TimerServiceUser *pTimerServiceUser)
schedule a timed event.
Definition: timerservice.cc:44
TimerEventId schedule(Function fn, const TimePoint &timePoint, const Duration &interval=Duration::zero())
std::size_t TimerEventId
Definition: types.h:54
Clock::time_point TimePoint
Definition: types.h:50
Platform timer service.
Definition: timerservice.h:53
Definition: agent.h:43