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 
27 namespace ns3 {
28 
39 {
40 public:
41 
43 
47  void Track (EventId event);
48 
50 
51 private:
52 
57  {
61  bool operator () (const EventId &a, const EventId &b) const
62  {
63  return (a.GetTs () < b.GetTs ());
64  }
65  };
66 
68  typedef std::multiset<EventId, EventIdLessThanTs> EventList;
69 
70  EventList::size_type m_nextCleanupSize;
71  EventList m_events;
72 
77  void Cleanup ();
81  void Grow ();
85  void Shrink ();
86 };
87 
88 } // namespace ns3
89 
90 #endif /* EVENT_GARBAGE_COLLECTOR_H */
comparison operator for std::multiset
std::multiset< EventId, EventIdLessThanTs > EventList
Event list container.
void Grow()
grow the cleanup limit
void Cleanup()
called when a new event was added and the cleanup limit was exceeded in consequence.
An object that tracks scheduled events and automatically cancels them when it is destroyed.
EventList m_events
the tracked event list
Every class exported by the ns3 library is enclosed in the ns3 namespace.
An identifier for simulation events.
Definition: event-id.h:53
bool operator()(const EventId &a, const EventId &b) const
comparison operator for std::multiset
EventList::size_type m_nextCleanupSize
batch size for cleanup
void Track(EventId event)
Tracks a new event.
void Shrink()
shrink the cleanup limit
uint64_t GetTs(void) const
Definition: event-id.cc:77