ns3::EventGarbageCollector Class Reference

An object that tracks scheduled events and automatically cancels them when it is destroyed. It is useful in situations where multiple instances of the same type of event can simultaneously be scheduled, and when the events should be limited to the lifetime of a container object. More...

#include <event-garbage-collector.h>

List of all members.

Classes

struct  EventIdLessThanTs

Public Member Functions

 EventGarbageCollector ()
void Track (EventId event)
 Tracks a new event.
 ~EventGarbageCollector ()

Private Types

typedef std::multiset< EventId,
EventIdLessThanTs
EventList

Private Member Functions

void Cleanup ()
void Grow ()
void Shrink ()

Private Attributes

EventList::size_type m_nextCleanupSize
EventList m_events

Detailed Description

An object that tracks scheduled events and automatically cancels them when it is destroyed. It is useful in situations where multiple instances of the same type of event can simultaneously be scheduled, and when the events should be limited to the lifetime of a container object.

Definition at line 36 of file event-garbage-collector.h.


Member Typedef Documentation

Definition at line 59 of file event-garbage-collector.h.


Constructor & Destructor Documentation

ns3::EventGarbageCollector::EventGarbageCollector (  ) 

Definition at line 29 of file event-garbage-collector.cc.

ns3::EventGarbageCollector::~EventGarbageCollector (  ) 

Definition at line 78 of file event-garbage-collector.cc.

References ns3::Simulator::Cancel(), and m_events.


Member Function Documentation

void ns3::EventGarbageCollector::Cleanup (  )  [private]

Definition at line 58 of file event-garbage-collector.cc.

References Grow(), m_events, m_nextCleanupSize, and Shrink().

Referenced by Track().

void ns3::EventGarbageCollector::Grow (  )  [private]

Definition at line 42 of file event-garbage-collector.cc.

References CLEANUP_CHUNK_MAX_SIZE, and m_nextCleanupSize.

Referenced by Cleanup(), and Shrink().

void ns3::EventGarbageCollector::Shrink (  )  [private]

Definition at line 49 of file event-garbage-collector.cc.

References Grow(), m_events, and m_nextCleanupSize.

Referenced by Cleanup().

void ns3::EventGarbageCollector::Track ( EventId  event  ) 

Member Data Documentation

Definition at line 62 of file event-garbage-collector.h.

Referenced by Cleanup(), Shrink(), Track(), and ~EventGarbageCollector().

EventList::size_type ns3::EventGarbageCollector::m_nextCleanupSize [private]

Definition at line 61 of file event-garbage-collector.h.

Referenced by Cleanup(), Grow(), Shrink(), and Track().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:10:02 2009 for NS-3 by  doxygen 1.6.3