A Discrete-Event Network Simulator
API
ipv4-queue-disc-item.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2016 Universita' degli Studi di Napoli Federico II
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 
19 #ifndef IPV4_QUEUE_DISC_ITEM_H
20 #define IPV4_QUEUE_DISC_ITEM_H
21 
22 #include "ns3/packet.h"
23 #include "ns3/queue-item.h"
24 #include "ipv4-header.h"
25 
26 namespace ns3 {
27 
37 public:
45  Ipv4QueueDiscItem (Ptr<Packet> p, const Address & addr, uint16_t protocol, const Ipv4Header & header);
46 
47  virtual ~Ipv4QueueDiscItem ();
48 
52  virtual uint32_t GetSize (void) const;
53 
57  const Ipv4Header & GetHeader (void) const;
58 
62  virtual void AddHeader (void);
63 
68  virtual void Print (std::ostream &os) const;
69 
70  /*
71  * The values for the fields of the Ipv4 header are taken from m_header and
72  * thus might differ from those present in the packet in case the header is
73  * modified after being added to the packet. However, this function is likely
74  * to be called before the header is added to the packet (i.e., before the
75  * packet is dequeued from the queue disc)
76  */
77  virtual bool GetUint8Value (Uint8Values field, uint8_t &value) const;
78 
84  virtual bool Mark (void);
85 
96  virtual uint32_t Hash (uint32_t perturbation) const;
97 
98 private:
118 
121 };
122 
123 } // namespace ns3
124 
125 #endif /* IPV4_QUEUE_DISC_ITEM_H */
ns3::QueueDiscItem
QueueDiscItem is the abstract base class for items that are stored in a queue disc.
Definition: queue-item.h:148
ns3::Ipv4Header
Packet header for IPv4.
Definition: ipv4-header.h:34
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::Ipv4QueueDiscItem::Mark
virtual bool Mark(void)
Marks the packet by setting ECN_CE bits if the packet has ECN_ECT0 or ECN_ECT1 set.
Definition: ipv4-queue-disc-item.cc:86
ns3::Ipv4QueueDiscItem::operator=
Ipv4QueueDiscItem & operator=(const Ipv4QueueDiscItem &)
Assignment operator.
ns3::Ipv4QueueDiscItem::GetHeader
const Ipv4Header & GetHeader(void) const
Definition: ipv4-queue-disc-item.cc:55
ns3::Ipv4QueueDiscItem::GetSize
virtual uint32_t GetSize(void) const
Definition: ipv4-queue-disc-item.cc:41
ns3::QueueItem::Uint8Values
Uint8Values
1-byte fields of the packet whose value can be retrieved, if present
Definition: queue-item.h:77
ns3::Ptr< Packet >
ns3::Ipv4QueueDiscItem::AddHeader
virtual void AddHeader(void)
Add the header to the packet.
Definition: ipv4-queue-disc-item.cc:60
ns3::Ipv4QueueDiscItem::Hash
virtual uint32_t Hash(uint32_t perturbation) const
Computes the hash of the packet's 5-tuple.
Definition: ipv4-queue-disc-item.cc:115
ns3::Address
a polymophic address class
Definition: address.h:91
ns3::Ipv4QueueDiscItem
Ipv4QueueDiscItem is a subclass of QueueDiscItem which stores IPv4 packets.
Definition: ipv4-queue-disc-item.h:36
ns3::Ipv4QueueDiscItem::~Ipv4QueueDiscItem
virtual ~Ipv4QueueDiscItem()
Definition: ipv4-queue-disc-item.cc:36
ns3::Ipv4QueueDiscItem::m_header
Ipv4Header m_header
The IPv4 header.
Definition: ipv4-queue-disc-item.h:119
ns3::Ipv4QueueDiscItem::Ipv4QueueDiscItem
Ipv4QueueDiscItem()
Default constructor.
ns3::Ipv4QueueDiscItem::GetUint8Value
virtual bool GetUint8Value(Uint8Values field, uint8_t &value) const
Retrieve the value of a given field from the packet, if present.
Definition: ipv4-queue-disc-item.cc:99
ns3::Ipv4QueueDiscItem::Print
virtual void Print(std::ostream &os) const
Print the item contents.
Definition: ipv4-queue-disc-item.cc:72
ns3::Ipv4QueueDiscItem::m_headerAdded
bool m_headerAdded
True if the header has already been added to the packet.
Definition: ipv4-queue-disc-item.h:120
ipv4-header.h
ns3::Ipv4QueueDiscItem::Ipv4QueueDiscItem
Ipv4QueueDiscItem(const Ipv4QueueDiscItem &)
Copy constructor.