ns-3
ns3::Scheduler Class Reference

Maintain the event list. More...

#include <scheduler.h>

Inheritance diagram for ns3::Scheduler:
Collaboration diagram for ns3::Scheduler:

List of all members.

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 Event RemoveNext (void)=0
virtual void Remove (const Event &ev)=0
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 This method returns the TypeId associated to ns3::Scheduler.

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
virtual void DoStart (void)
virtual void DoDispose (void)
 Object (const Object &o)

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.


Member Function Documentation

TypeId ns3::Scheduler::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::Scheduler.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.

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

References ns3::TypeId::SetParent().

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::HeapScheduler, ns3::ListScheduler, and ns3::MapScheduler.

Referenced by ns3::DefaultSimulatorImpl::Remove(), ns3::RealtimeSimulatorImpl::Remove(), and ns3::DistributedSimulatorImpl::Remove().

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.

Referenced by ns3::DefaultSimulatorImpl::SetScheduler(), ns3::RealtimeSimulatorImpl::SetScheduler(), and ns3::DistributedSimulatorImpl::SetScheduler().


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