A Discrete-Event Network Simulator
API
priority-queue-scheduler.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2006 INRIA
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19 */
20
21#ifndef PRIORITY_QUEUE_SCHEDULER_H
22#define PRIORITY_QUEUE_SCHEDULER_H
23
24#include "scheduler.h"
25#include <functional>
26#include <algorithm>
27#include <stdint.h>
28#include <utility>
29#include <queue>
30
37namespace ns3 {
38
64class PriorityQueueScheduler : public Scheduler
65{
66public:
71 static TypeId GetTypeId (void);
72
74 PriorityQueueScheduler ();
76 virtual ~PriorityQueueScheduler ();
77
78 // Inherited
79 virtual void Insert (const Scheduler::Event &ev);
80 virtual bool IsEmpty (void) const;
81 virtual Scheduler::Event PeekNext (void) const;
82 virtual Scheduler::Event RemoveNext (void);
83 virtual void Remove (const Scheduler::Event &ev);
84
85private:
86
91 class EventPriorityQueue :
92 public std::priority_queue<Scheduler::Event,
93 std::vector <Scheduler::Event>,
94 std::greater<Scheduler::Event> >
95 {
96 public:
97
102 bool remove(const Scheduler::Event &ev);
103
104 }; // class EventPriorityQueue
105
107 EventPriorityQueue m_queue;
108
109}; // class PriorityQueueScheduler
110
111} // namespace ns3
112
113#endif /* PRIORITY_QUEUE_SCHEDULER_H */
ns3::PriorityQueueScheduler::EventPriorityQueue
Custom priority_queue which supports remove, and returns entries in increasing time order.
Definition: priority-queue-scheduler.h:95
ns3::PriorityQueueScheduler::EventPriorityQueue::remove
bool remove(const Scheduler::Event &ev)
Remove a specific event from the event list.
Definition: priority-queue-scheduler.cc:92
ns3::PriorityQueueScheduler
a std::priority_queue event scheduler
Definition: priority-queue-scheduler.h:65
ns3::PriorityQueueScheduler::Remove
virtual void Remove(const Scheduler::Event &ev)
Remove a specific event from the event list.
Definition: priority-queue-scheduler.cc:108
ns3::PriorityQueueScheduler::Insert
virtual void Insert(const Scheduler::Event &ev)
Insert a new Event in the schedule.
Definition: priority-queue-scheduler.cc:62
ns3::PriorityQueueScheduler::PeekNext
virtual Scheduler::Event PeekNext(void) const
Get a pointer to the next event.
Definition: priority-queue-scheduler.cc:76
ns3::PriorityQueueScheduler::IsEmpty
virtual bool IsEmpty(void) const
Test if the schedule is empty.
Definition: priority-queue-scheduler.cc:69
ns3::PriorityQueueScheduler::~PriorityQueueScheduler
virtual ~PriorityQueueScheduler()
Destructor.
Definition: priority-queue-scheduler.cc:56
ns3::PriorityQueueScheduler::GetTypeId
static TypeId GetTypeId(void)
Register this type.
Definition: priority-queue-scheduler.cc:42
ns3::PriorityQueueScheduler::m_queue
EventPriorityQueue m_queue
The event queue.
Definition: priority-queue-scheduler.h:107
ns3::PriorityQueueScheduler::RemoveNext
virtual Scheduler::Event RemoveNext(void)
Remove the earliest event from the event list.
Definition: priority-queue-scheduler.cc:83
ns3::Scheduler
Maintain the event list.
Definition: scheduler.h:156
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
scheduler.h
ns3::Scheduler abstract base class, ns3::Scheduler::Event and ns3::Scheduler::EventKey declarations.
ns3::Scheduler::Event
Scheduler event.
Definition: scheduler.h:182