A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::Scheduler Class Referenceabstract

Maintain the event list. More...

#include <scheduler.h>

+ Inheritance diagram for ns3::Scheduler:

Classes

struct  Event
 
struct  EventKey
 

Public Member Functions

virtual void Insert (const Event &ev)=0
 
virtual bool IsEmpty (void) const =0
 
virtual Event PeekNext (void) const =0
 
virtual void Remove (const Event &ev)=0
 
virtual Event RemoveNext (void)=0
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

Maintain the event list.

This base class specifies the interface used to maintain the event list. If you want to provide a new event list scheduler, you need to create a subclass of this base class and implement all the pure virtual methods defined here.

The only tricky aspect of this API is the memory management of the EventImpl pointer which is a member of the Event data structure. The lifetime of this pointer is assumed to always be longer than the lifetime of the Scheduler class which means that the caller is responsible for ensuring that this invariant holds through calling EventId::Ref and SimpleRefCount::Unref at the right time. Typically, EventId::Ref is called before Insert and SimpleRefCount::Unref is called after a call to one of the Remove methods.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 53 of file scheduler.h.

Member Function Documentation

virtual void ns3::Scheduler::Insert ( const Event ev)
pure virtual
Parameters
evevent to store in the event list

Implemented in ns3::CalendarScheduler, ns3::ListScheduler, and ns3::MapScheduler.

virtual bool ns3::Scheduler::IsEmpty ( void  ) const
pure virtual
Returns
true if the event list is empty and false otherwise.

Implemented in ns3::CalendarScheduler, ns3::HeapScheduler, ns3::ListScheduler, and ns3::MapScheduler.

virtual Event ns3::Scheduler::PeekNext ( void  ) const
pure virtual
Returns
a pointer to the next earliest event. The caller takes ownership of the returned pointer.

This method cannot be invoked if the list is empty.

Implemented in ns3::CalendarScheduler, ns3::HeapScheduler, ns3::ListScheduler, and ns3::MapScheduler.

virtual void ns3::Scheduler::Remove ( const Event ev)
pure virtual
Parameters
evthe event to remove

This methods cannot be invoked if the list is empty.

Implemented in ns3::CalendarScheduler, ns3::ListScheduler, and ns3::MapScheduler.

virtual Event ns3::Scheduler::RemoveNext ( void  )
pure virtual

This method cannot be invoked if the list is empty. Remove the next earliest event from the event list.

Implemented in ns3::CalendarScheduler, ns3::HeapScheduler, ns3::ListScheduler, and ns3::MapScheduler.


The documentation for this class was generated from the following files: