A Discrete-Event Network Simulator
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
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  */
24 #include "simulator-impl.h"
25 #include "scheduler.h"
26 #include "event-impl.h"
27 #include "system-thread.h"
28 #include "system-mutex.h"
30 #include "ptr.h"
32 #include <list>
40 namespace ns3 {
48 {
49 public:
54  static TypeId GetTypeId (void);
61  // Inherited
62  virtual void Destroy ();
63  virtual bool IsFinished (void) const;
64  virtual void Stop (void);
65  virtual void Stop (const Time &delay);
66  virtual EventId Schedule (const Time &delay, EventImpl *event);
67  virtual void ScheduleWithContext (uint32_t context, const Time &delay, EventImpl *event);
68  virtual EventId ScheduleNow (EventImpl *event);
69  virtual EventId ScheduleDestroy (EventImpl *event);
70  virtual void Remove (const EventId &id);
71  virtual void Cancel (const EventId &id);
72  virtual bool IsExpired (const EventId &id) const;
73  virtual void Run (void);
74  virtual Time Now (void) const;
75  virtual Time GetDelayLeft (const EventId &id) const;
76  virtual Time GetMaximumSimulationTime (void) const;
77  virtual void SetScheduler (ObjectFactory schedulerFactory);
78  virtual uint32_t GetSystemId (void) const;
79  virtual uint32_t GetContext (void) const;
81 private:
82  virtual void DoDispose (void);
85  void ProcessOneEvent (void);
87  void ProcessEventsWithContext (void);
92  uint32_t context;
94  uint64_t timestamp;
97  };
99  typedef std::list<struct EventWithContext> EventsWithContext;
101  EventsWithContext m_eventsWithContext;
111  typedef std::list<EventId> DestroyEvents;
113  DestroyEvents m_destroyEvents;
115  bool m_stop;
120  uint32_t m_uid;
122  uint32_t m_currentUid;
124  uint64_t m_currentTs;
135 };
137 } // namespace ns3
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
EventsWithContext m_eventsWithContext
The container of events from a different context.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
uint32_t m_currentUid
Unique id of the current event.
ns3::EventImpl declarations.
Ptr< Scheduler > m_events
The event priority queue.
int m_unscheduledEvents
Number of events that have been inserted but not yet scheduled, not counting the Destroy events; this...
virtual void DoDispose(void)
Destructor implementation.
System-independent thread class ns3::SystemThread declaration.
ns3::Ptr smart pointer declaration and implementation.
virtual Time GetMaximumSimulationTime(void) const
Get the maximum representable simulation time.
virtual void SetScheduler(ObjectFactory schedulerFactory)
Set the Scheduler to be used to manage the event list.
uint32_t m_uid
Next event unique id.
Wrap an event with its execution context.
DestroyEvents m_destroyEvents
The container of events to run at Destroy.
SystemMutex m_eventsWithContextMutex
Mutex to control access to the list of events with context.
virtual EventId ScheduleNow(EventImpl *event)
Schedule an event to run at the current virtual time.
virtual uint32_t GetSystemId(void) const
Get the system id of this simulator.
virtual void Cancel(const EventId &id)
Set the cancel bit on this event: the event's associated function will not be invoked when it expires...
ns3::SimulatorImpl declaration.
EventImpl * event
The event implementation.
System-independent mutex primitive, ns3::SystemMutex, and ns3::CriticalSection.
ns3::Scheduler abstract base class, ns3::Scheduler::Event and ns3::Scheduler::EventKey declarations...
bool m_stop
Flag calling for the end of the simulation.
static TypeId GetTypeId(void)
Register this type.
virtual Time Now(void) const
Return the current simulation virtual time.
uint32_t m_currentContext
Execution context of the current event.
pthread_t ThreadId
Type alias for the system-dependent thread object.
Definition: system-thread.h:62
virtual Time GetDelayLeft(const EventId &id) const
Get the remaining time until this event will execute.
virtual EventId ScheduleDestroy(EventImpl *event)
Schedule an event to run at the end of the simulation, after the Stop() time or condition has been re...
std::list< struct EventWithContext > EventsWithContext
Container type for the events from a different context.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual void Stop(void)
Tell the Simulator the calling event should be the last one executed.
virtual uint32_t GetContext(void) const
Get the current simulation context.
virtual void Remove(const EventId &id)
Remove an event from the event list.
A class which provides a relatively platform-independent Mutual Exclusion thread synchronization prim...
Definition: system-mutex.h:58
The default single process simulator implementation.
uint64_t m_currentTs
Timestamp of the current event.
virtual EventId Schedule(const Time &delay, EventImpl *event)
Schedule a future event execution (in the same context).
Instantiate subclasses of ns3::Object.
A simulation event.
Definition: event-impl.h:44
virtual void ScheduleWithContext(uint32_t context, const Time &delay, EventImpl *event)
Schedule a future event execution (in a different context).
virtual bool IsFinished(void) const
Check if the simulation should finish.
virtual void Run(void)
Run the simulation.
An identifier for simulation events.
Definition: event-id.h:53
virtual void Destroy()
Execute the events scheduled with ScheduleDestroy().
virtual bool IsExpired(const EventId &id) const
Check if an event has already run or been cancelled.
SystemThread::ThreadId m_main
Main execution thread.
std::list< EventId > DestroyEvents
Container type for the events to run at Simulator::Destroy()
void ProcessOneEvent(void)
Process the next event.
bool m_eventsWithContextEmpty
Flag true if all events with context have been moved to the primary event queue.
a unique identifier for an interface.
Definition: type-id.h:58
The SimulatorImpl base class.
void ProcessEventsWithContext(void)
Move events from a different context into the main event queue.