A Discrete-Event Network Simulator
API
traffic-control-layer.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2015 Natale Patriciello <natale.patriciello@gmail.com>
4  * 2016 Stefano Avallone <stavallo@unina.it>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation;
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19 #ifndef TRAFFICCONTROLLAYER_H
20 #define TRAFFICCONTROLLAYER_H
21 
22 #include "ns3/object.h"
23 #include "ns3/address.h"
24 #include "ns3/net-device.h"
25 #include "ns3/node.h"
26 #include "ns3/queue-item.h"
27 #include <map>
28 #include <vector>
29 
30 namespace ns3 {
31 
32 class Packet;
33 class QueueDisc;
34 class NetDeviceQueueInterface;
35 
90 {
91 public:
96  static TypeId GetTypeId (void);
97 
102  virtual TypeId GetInstanceTypeId (void) const;
103 
108 
109  virtual ~TrafficControlLayer ();
110 
129  uint16_t protocolType,
130  Ptr<NetDevice> device);
131 
133  typedef std::vector<Ptr<QueueDisc> > QueueDiscVector;
134 
142  virtual void SetupDevice (Ptr<NetDevice> device);
143 
150  virtual void SetRootQueueDiscOnDevice (Ptr<NetDevice> device, Ptr<QueueDisc> qDisc);
151 
159 
166  virtual void DeleteRootQueueDiscOnDevice (Ptr<NetDevice> device);
167 
172  void SetNode (Ptr<Node> node);
173 
187  virtual void Receive (Ptr<NetDevice> device, Ptr<const Packet> p,
188  uint16_t protocol, const Address &from,
189  const Address &to, NetDevice::PacketType packetType);
196  virtual void Send (Ptr<NetDevice> device, Ptr<QueueDiscItem> item);
197 
200 
201 protected:
202 
203  virtual void DoDispose (void);
204  virtual void DoInitialize (void);
205  virtual void NotifyNewAggregate (void);
206 
207 private:
226  uint16_t protocol;
227  bool promiscuous;
228  };
229 
234  {
235  public:
245  QueueDiscVector queueDiscsToWake, SelectQueueCallback selectQueueCallback);
246  virtual ~NetDeviceInfo ();
247 
252  private:
253  NetDeviceInfo ();
258  NetDeviceInfo (NetDeviceInfo const &);
265  };
266 
268  typedef std::vector<struct ProtocolHandlerEntry> ProtocolHandlerList;
269 
274  uint32_t GetNDevices (void) const;
280  Ptr<QueueDisc> GetRootQueueDiscOnDeviceByIndex (uint32_t index) const;
281 
285  std::map<Ptr<NetDevice>, NetDeviceInfo> m_netDevices;
287 };
288 
289 } // namespace ns3
290 
291 #endif // TRAFFICCONTROLLAYER_H
Ptr< NetDeviceQueueInterface > m_ndqi
the netdevice queue interface
virtual void DeleteRootQueueDiscOnDevice(Ptr< NetDevice > device)
This method can be used to remove the root queue disc (and associated filters, classes and queues) in...
uint32_t GetNDevices(void) const
Required by the object map accessor.
Callback< uint8_t, Ptr< QueueItem > > SelectQueueCallback
Callback invoked to determine the tx queue selected for a given packet.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
virtual void SetRootQueueDiscOnDevice(Ptr< NetDevice > device, Ptr< QueueDisc > qDisc)
This method can be used to set the root queue disc installed on a device.
Introspection did not find any typical Config paths.
ProtocolHandlerList m_handlers
List of upper-layer handlers.
bool promiscuous
true if it is a promiscuous handler
virtual void DoInitialize(void)
Initialize() implementation.
virtual void NotifyNewAggregate(void)
Notify all Objects aggregated to this one of a new Object being aggregated.
virtual void Receive(Ptr< NetDevice > device, Ptr< const Packet > p, uint16_t protocol, const Address &from, const Address &to, NetDevice::PacketType packetType)
Called by NetDevices, incoming packet.
uint16_t protocol
the protocol number
a polymophic address class
Definition: address.h:90
void SetNode(Ptr< Node > node)
Set node associated with this stack.
Ptr< QueueDisc > m_rootQueueDisc
the root queue disc on the device
NetDeviceInfo & operator=(NetDeviceInfo const &)
Assignment operator.
std::vector< Ptr< QueueDisc > > QueueDiscVector
Typedef for queue disc vector.
Ptr< NetDevice > device
the NetDevice
std::vector< struct ProtocolHandlerEntry > ProtocolHandlerList
Typedef for protocol handlers container.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual TypeId GetInstanceTypeId(void) const
Get the type ID for the instance.
static TypeId GetTypeId(void)
Get the type ID.
Information to store for each device.
virtual void Send(Ptr< NetDevice > device, Ptr< QueueDiscItem > item)
Called from upper layer to queue a packet for the transmission.
Ptr< Node > m_node
The node this TrafficControlLayer object is aggregated to.
TrafficControlLayer & operator=(TrafficControlLayer const &)
Assignment operator.
std::map< Ptr< NetDevice >, NetDeviceInfo > m_netDevices
Map storing the required information for each device with a queue disc installed. ...
Protocol handler entry.
virtual void SetupDevice(Ptr< NetDevice > device)
Perform the operations that the traffic control layer needs to do when an IPv4/v6 interface is added ...
Ptr< QueueDisc > GetRootQueueDiscOnDeviceByIndex(uint32_t index) const
Required by the object map accessor.
Node::ProtocolHandler handler
the protocol handler
A base class which provides memory management and object aggregation.
Definition: object.h:87
PacketType
Packet types are used as they are in Linux.
Definition: net-device.h:296
virtual void DoDispose(void)
Destructor implementation.
a unique identifier for an interface.
Definition: type-id.h:58
void RegisterProtocolHandler(Node::ProtocolHandler handler, uint16_t protocolType, Ptr< NetDevice > device)
Register an IN handler.
virtual Ptr< QueueDisc > GetRootQueueDiscOnDevice(Ptr< NetDevice > device) const
This method can be used to get the root queue disc installed on a device.
QueueDiscVector m_queueDiscsToWake
the vector of queue discs to wake
SelectQueueCallback m_selectQueueCallback
the select queue callback