A Discrete-Event Network Simulator
API
event-impl.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2005,2006 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 #ifndef EVENT_IMPL_H
20 #define EVENT_IMPL_H
21 
22 #include "simple-ref-count.h"
23 
24 #include <stdint.h>
25 
32 namespace ns3
33 {
34 
45 class EventImpl : public SimpleRefCount<EventImpl>
46 {
47  public:
49  EventImpl();
51  virtual ~EventImpl() = 0;
56  void Invoke();
62  void Cancel();
68  bool IsCancelled();
69 
70  protected:
77  virtual void Notify() = 0;
78 
79  private:
80  bool m_cancel;
81 };
82 
83 } // namespace ns3
84 
85 #endif /* EVENT_IMPL_H */
A simulation event.
Definition: event-impl.h:46
EventImpl()
Default constructor.
Definition: event-impl.cc:40
void Invoke()
Called by the simulation engine to notify the event that it is time to execute.
Definition: event-impl.cc:47
virtual void Notify()=0
Implementation for Invoke().
void Cancel()
Marks the event as 'canceled'.
Definition: event-impl.cc:57
virtual ~EventImpl()=0
Destructor.
Definition: event-impl.cc:35
bool m_cancel
Has this event been cancelled.
Definition: event-impl.h:80
bool IsCancelled()
Definition: event-impl.cc:64
A template-based reference counting class.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::SimpleRefCount declaration and template implementation.