A Discrete-Event Network Simulator
API
fifo-queue-disc.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Universita' degli Studi di Napoli Federico II
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Authors: Stefano Avallone <stavallo@unina.it>
18  */
19 
20 #ifndef FIFO_QUEUE_DISC_H
21 #define FIFO_QUEUE_DISC_H
22 
23 #include "queue-disc.h"
24 
25 namespace ns3
26 {
27 
34 class FifoQueueDisc : public QueueDisc
35 {
36  public:
41  static TypeId GetTypeId();
47  FifoQueueDisc();
48 
49  ~FifoQueueDisc() override;
50 
51  // Reasons for dropping packets
52  static constexpr const char* LIMIT_EXCEEDED_DROP =
53  "Queue disc limit exceeded";
54 
55  private:
56  bool DoEnqueue(Ptr<QueueDiscItem> item) override;
57  Ptr<QueueDiscItem> DoDequeue() override;
58  Ptr<const QueueDiscItem> DoPeek() override;
59  bool CheckConfig() override;
60  void InitializeParams() override;
61 };
62 
63 } // namespace ns3
64 
65 #endif /* FIFO_QUEUE_DISC_H */
ns3::FifoQueueDisc
Simple queue disc implementing the FIFO (First-In First-Out) policy.
Definition: fifo-queue-disc.h:35
ns3::FifoQueueDisc::FifoQueueDisc
FifoQueueDisc()
FifoQueueDisc constructor.
Definition: fifo-queue-disc.cc:49
ns3::FifoQueueDisc::DoPeek
Ptr< const QueueDiscItem > DoPeek() override
Return a copy of the next packet the queue disc will extract.
Definition: fifo-queue-disc.cc:100
ns3::FifoQueueDisc::DoDequeue
Ptr< QueueDiscItem > DoDequeue() override
This function actually extracts a packet from the queue disc.
Definition: fifo-queue-disc.cc:84
ns3::FifoQueueDisc::CheckConfig
bool CheckConfig() override
Check whether the current configuration is correct.
Definition: fifo-queue-disc.cc:116
ns3::FifoQueueDisc::InitializeParams
void InitializeParams() override
Initialize parameters (if any) before the first packet is enqueued.
Definition: fifo-queue-disc.cc:149
ns3::FifoQueueDisc::DoEnqueue
bool DoEnqueue(Ptr< QueueDiscItem > item) override
This function actually enqueues a packet into the queue disc.
Definition: fifo-queue-disc.cc:61
ns3::FifoQueueDisc::LIMIT_EXCEEDED_DROP
static constexpr const char * LIMIT_EXCEEDED_DROP
Packet dropped due to queue disc limit exceeded.
Definition: fifo-queue-disc.h:52
ns3::FifoQueueDisc::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition: fifo-queue-disc.cc:34
ns3::FifoQueueDisc::~FifoQueueDisc
~FifoQueueDisc() override
Definition: fifo-queue-disc.cc:55
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
ns3::QueueDisc
QueueDisc is an abstract base class providing the interface and implementing the operations common to...
Definition: queue-disc.h:184
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.