ns3::Scheduler Class Reference
[Scheduler]

Maintain the event list. More...

#include <scheduler.h>

Inheritance diagram for ns3::Scheduler:

[legend]

Collaboration diagram for ns3::Scheduler:

[legend]

List of all members.

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
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::Scheduler.

---

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 EventImpl::Ref and EventImpl::Unref at the right time. Typically, Ref is called before Insert and Unref is called after a call to one of the Remove methods.

---

Member Function Documentation

static 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, ns3::MapScheduler, and ns3::Ns2CalendarScheduler.

virtual void ns3::Scheduler::Insert

(

const Event &

ev

)

[pure virtual]

Parameters:

ev

event to store in the event list

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

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

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

virtual void ns3::Scheduler::Remove

(

const Event &

ev

)

[pure virtual]

Parameters:

ev

the event to remove

This methods cannot be invoked if the list is empty.

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

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

---

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

• src/simulator/scheduler.h
• doc/introspected-doxygen.h