A Discrete-Event Network Simulator
API
event-garbage-collector.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007 INESC Porto
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: Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
19  */
20 #ifndef EVENT_GARBAGE_COLLECTOR_H
21 #define EVENT_GARBAGE_COLLECTOR_H
22 
23 #include <set>
24 #include "ns3/event-id.h"
25 #include "ns3/simulator.h"
26 
34 namespace ns3 {
35 
47 {
48 public:
49 
51 
56  void Track (EventId event);
57 
59 
60 private:
61 
63  typedef std::multiset<EventId> EventList;
64 
66  const typename EventList::size_type CHUNK_INIT_SIZE = 8;
71  const typename EventList::size_type CHUNK_MAX_SIZE = 128;
72 
73  EventList::size_type m_nextCleanupSize;
75 
80  void Cleanup ();
87  void Grow ();
93  void Shrink ();
94 };
95 
96 } // namespace ns3
97 
98 #endif /* EVENT_GARBAGE_COLLECTOR_H */
An object that tracks scheduled events and automatically cancels them when it is destroyed.
const EventList::size_type CHUNK_INIT_SIZE
Initial threshold for cleaning the event list.
void Track(EventId event)
Tracks a new event.
const EventList::size_type CHUNK_MAX_SIZE
Threshold to switch from exponential to linear growth in the cleanup frequency.
EventList m_events
The tracked event list.
void Cleanup()
Called when a new event was added and the cleanup limit was exceeded in consequence.
EventList::size_type m_nextCleanupSize
Batch size for cleanup.
void Grow()
Grow the cleanup limit.
void Shrink()
Shrink the cleanup limit Reduce the cleanup size by factors of two until less than the current event ...
std::multiset< EventId > EventList
Event list container.
An identifier for simulation events.
Definition: event-id.h:54
Every class exported by the ns3 library is enclosed in the ns3 namespace.