A Discrete-Event Network Simulator
API
watchdog.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2007 INRIA
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
18  */
19 #include "watchdog.h"
20 
21 #include "log.h"
22 
29 namespace ns3
30 {
31 
32 NS_LOG_COMPONENT_DEFINE("Watchdog");
33 
35  : m_impl(nullptr),
36  m_event(),
37  m_end(MicroSeconds(0))
38 {
40 }
41 
43 {
44  NS_LOG_FUNCTION(this);
45  m_event.Cancel();
46  delete m_impl;
47 }
48 
49 void
51 {
52  NS_LOG_FUNCTION(this << delay);
53  Time end = Simulator::Now() + delay;
54  m_end = std::max(m_end, end);
55  if (m_event.IsRunning())
56  {
57  return;
58  }
60 }
61 
62 void
64 {
65  NS_LOG_FUNCTION(this);
66  if (m_end == Simulator::Now())
67  {
68  m_impl->Invoke();
69  }
70  else
71  {
73  }
74 }
75 
76 } // namespace ns3
#define max(a, b)
Definition: 80211b.c:42
void Cancel()
This method is syntactic sugar for the ns3::Simulator::Cancel method.
Definition: event-id.cc:55
bool IsRunning() const
This method is syntactic sugar for !IsExpired().
Definition: event-id.cc:76
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:571
static Time Now()
Return the current simulation virtual time.
Definition: simulator.cc:208
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
virtual void Invoke()=0
Invoke the expire function.
void Expire()
Internal callback invoked when the timer expires.
Definition: watchdog.cc:63
EventId m_event
The future event scheduled to expire the timer.
Definition: watchdog.h:120
~Watchdog()
Destructor.
Definition: watchdog.cc:42
Watchdog()
Constructor.
Definition: watchdog.cc:34
void Ping(Time delay)
Delay the timer.
Definition: watchdog.cc:50
TimerImpl * m_impl
The timer implementation, which contains the bound callback function and arguments.
Definition: watchdog.h:118
Time m_end
The absolute time when the timer will expire.
Definition: watchdog.h:122
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_FUNCTION_NOARGS()
Output the name of the function.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Time Now()
create an ns3::Time instance which contains the current simulation time.
Definition: simulator.cc:305
Time MicroSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:1350
Debug message logging.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::Watchdog timer class declaration.