A Discrete-Event Network Simulator
API
event-impl.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005,2006 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef EVENT_IMPL_H
21 #define EVENT_IMPL_H
22 
23 #include <stdint.h>
24 #include "simple-ref-count.h"
25 
32 namespace ns3 {
33 
44 class EventImpl : public SimpleRefCount<EventImpl>
45 {
46 public:
48  EventImpl ();
50  virtual ~EventImpl () = 0;
55  void Invoke (void);
61  void Cancel (void);
67  bool IsCancelled (void);
68 
69 protected:
76  virtual void Notify (void) = 0;
77 
78 private:
79  bool m_cancel;
80 };
81 
82 } // namespace ns3
83 
84 #endif /* EVENT_IMPL_H */
EventImpl()
Default constructor.
Definition: event-impl.cc:39
bool IsCancelled(void)
Definition: event-impl.cc:63
void Cancel(void)
Marks the event as &#39;canceled&#39;.
Definition: event-impl.cc:56
void Invoke(void)
Called by the simulation engine to notify the event that it is time to execute.
Definition: event-impl.cc:46
virtual void Notify(void)=0
Implementation for Invoke().
bool m_cancel
Has this event been cancelled.
Definition: event-impl.h:79
Every class exported by the ns3 library is enclosed in the ns3 namespace.
A simulation event.
Definition: event-impl.h:44
virtual ~EventImpl()=0
Destructor.
Definition: event-impl.cc:34
A template-based reference counting class.
ns3::SimpleRefCount declaration and template implementation.