A Discrete-Event Network Simulator
API
traffic-control-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2015 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  * Author: Stefano Avallone <stavallo@unina.it>
19  */
20 #ifndef TRAFFIC_CONTROL_HELPER_H
21 #define TRAFFIC_CONTROL_HELPER_H
22 
23 #include <string>
24 #include <vector>
25 #include <map>
26 #include "ns3/object-factory.h"
27 #include "ns3/net-device-container.h"
28 #include "ns3/queue-disc-container.h"
29 
30 namespace ns3 {
31 
38 class QueueDiscFactory
39 {
40 public:
46  QueueDiscFactory (ObjectFactory factory);
47 
48  virtual ~QueueDiscFactory () {}
49 
55  void AddInternalQueue (ObjectFactory factory);
56 
62  void AddPacketFilter (ObjectFactory factory);
63 
70  uint16_t AddQueueDiscClass (ObjectFactory factory);
71 
78  void SetChildQueueDisc (uint16_t classId, uint16_t handle);
79 
86  Ptr<QueueDisc> CreateQueueDisc (const std::vector<Ptr<QueueDisc> > & queueDiscs);
87 
88 private:
94  QueueDiscFactory ();
95 
97  ObjectFactory m_queueDiscFactory;
99  std::vector<ObjectFactory> m_internalQueuesFactory;
101  std::vector<ObjectFactory> m_packetFiltersFactory;
103  std::vector<ObjectFactory> m_queueDiscClassesFactory;
105  std::map<uint16_t, uint16_t> m_classIdChildHandleMap;
106 };
107 
108 
118 class TrafficControlHelper
119 {
120 public:
125  TrafficControlHelper ();
126  virtual ~TrafficControlHelper () {}
127 
134  static TrafficControlHelper Default (void);
135 
174  uint16_t SetRootQueueDisc (std::string type,
175  std::string n01 = "", const AttributeValue &v01 = EmptyAttributeValue (),
176  std::string n02 = "", const AttributeValue &v02 = EmptyAttributeValue (),
177  std::string n03 = "", const AttributeValue &v03 = EmptyAttributeValue (),
178  std::string n04 = "", const AttributeValue &v04 = EmptyAttributeValue (),
179  std::string n05 = "", const AttributeValue &v05 = EmptyAttributeValue (),
180  std::string n06 = "", const AttributeValue &v06 = EmptyAttributeValue (),
181  std::string n07 = "", const AttributeValue &v07 = EmptyAttributeValue (),
182  std::string n08 = "", const AttributeValue &v08 = EmptyAttributeValue (),
183  std::string n09 = "", const AttributeValue &v09 = EmptyAttributeValue (),
184  std::string n10 = "", const AttributeValue &v10 = EmptyAttributeValue (),
185  std::string n11 = "", const AttributeValue &v11 = EmptyAttributeValue (),
186  std::string n12 = "", const AttributeValue &v12 = EmptyAttributeValue (),
187  std::string n13 = "", const AttributeValue &v13 = EmptyAttributeValue (),
188  std::string n14 = "", const AttributeValue &v14 = EmptyAttributeValue (),
189  std::string n15 = "", const AttributeValue &v15 = EmptyAttributeValue ());
190 
215  void AddInternalQueues (uint16_t handle, uint16_t count, std::string type,
216  std::string n01 = "", const AttributeValue &v01 = EmptyAttributeValue (),
217  std::string n02 = "", const AttributeValue &v02 = EmptyAttributeValue (),
218  std::string n03 = "", const AttributeValue &v03 = EmptyAttributeValue (),
219  std::string n04 = "", const AttributeValue &v04 = EmptyAttributeValue (),
220  std::string n05 = "", const AttributeValue &v05 = EmptyAttributeValue (),
221  std::string n06 = "", const AttributeValue &v06 = EmptyAttributeValue (),
222  std::string n07 = "", const AttributeValue &v07 = EmptyAttributeValue (),
223  std::string n08 = "", const AttributeValue &v08 = EmptyAttributeValue ());
224 
248  void AddPacketFilter (uint16_t handle, std::string type,
249  std::string n01 = "", const AttributeValue &v01 = EmptyAttributeValue (),
250  std::string n02 = "", const AttributeValue &v02 = EmptyAttributeValue (),
251  std::string n03 = "", const AttributeValue &v03 = EmptyAttributeValue (),
252  std::string n04 = "", const AttributeValue &v04 = EmptyAttributeValue (),
253  std::string n05 = "", const AttributeValue &v05 = EmptyAttributeValue (),
254  std::string n06 = "", const AttributeValue &v06 = EmptyAttributeValue (),
255  std::string n07 = "", const AttributeValue &v07 = EmptyAttributeValue (),
256  std::string n08 = "", const AttributeValue &v08 = EmptyAttributeValue ());
257 
261  typedef std::vector<uint16_t> ClassIdList;
262 
288  ClassIdList AddQueueDiscClasses (uint16_t handle, uint16_t count, std::string type,
289  std::string n01 = "", const AttributeValue &v01 = EmptyAttributeValue (),
290  std::string n02 = "", const AttributeValue &v02 = EmptyAttributeValue (),
291  std::string n03 = "", const AttributeValue &v03 = EmptyAttributeValue (),
292  std::string n04 = "", const AttributeValue &v04 = EmptyAttributeValue (),
293  std::string n05 = "", const AttributeValue &v05 = EmptyAttributeValue (),
294  std::string n06 = "", const AttributeValue &v06 = EmptyAttributeValue (),
295  std::string n07 = "", const AttributeValue &v07 = EmptyAttributeValue (),
296  std::string n08 = "", const AttributeValue &v08 = EmptyAttributeValue ());
297 
338  uint16_t AddChildQueueDisc (uint16_t handle, uint16_t classId, std::string type,
339  std::string n01 = "", const AttributeValue &v01 = EmptyAttributeValue (),
340  std::string n02 = "", const AttributeValue &v02 = EmptyAttributeValue (),
341  std::string n03 = "", const AttributeValue &v03 = EmptyAttributeValue (),
342  std::string n04 = "", const AttributeValue &v04 = EmptyAttributeValue (),
343  std::string n05 = "", const AttributeValue &v05 = EmptyAttributeValue (),
344  std::string n06 = "", const AttributeValue &v06 = EmptyAttributeValue (),
345  std::string n07 = "", const AttributeValue &v07 = EmptyAttributeValue (),
346  std::string n08 = "", const AttributeValue &v08 = EmptyAttributeValue (),
347  std::string n09 = "", const AttributeValue &v09 = EmptyAttributeValue (),
348  std::string n10 = "", const AttributeValue &v10 = EmptyAttributeValue (),
349  std::string n11 = "", const AttributeValue &v11 = EmptyAttributeValue (),
350  std::string n12 = "", const AttributeValue &v12 = EmptyAttributeValue (),
351  std::string n13 = "", const AttributeValue &v13 = EmptyAttributeValue (),
352  std::string n14 = "", const AttributeValue &v14 = EmptyAttributeValue (),
353  std::string n15 = "", const AttributeValue &v15 = EmptyAttributeValue ());
354 
358  typedef std::vector<uint16_t> HandleList;
359 
400  HandleList AddChildQueueDiscs (uint16_t handle, const ClassIdList &classes, std::string type,
401  std::string n01 = "", const AttributeValue &v01 = EmptyAttributeValue (),
402  std::string n02 = "", const AttributeValue &v02 = EmptyAttributeValue (),
403  std::string n03 = "", const AttributeValue &v03 = EmptyAttributeValue (),
404  std::string n04 = "", const AttributeValue &v04 = EmptyAttributeValue (),
405  std::string n05 = "", const AttributeValue &v05 = EmptyAttributeValue (),
406  std::string n06 = "", const AttributeValue &v06 = EmptyAttributeValue (),
407  std::string n07 = "", const AttributeValue &v07 = EmptyAttributeValue (),
408  std::string n08 = "", const AttributeValue &v08 = EmptyAttributeValue (),
409  std::string n09 = "", const AttributeValue &v09 = EmptyAttributeValue (),
410  std::string n10 = "", const AttributeValue &v10 = EmptyAttributeValue (),
411  std::string n11 = "", const AttributeValue &v11 = EmptyAttributeValue (),
412  std::string n12 = "", const AttributeValue &v12 = EmptyAttributeValue (),
413  std::string n13 = "", const AttributeValue &v13 = EmptyAttributeValue (),
414  std::string n14 = "", const AttributeValue &v14 = EmptyAttributeValue (),
415  std::string n15 = "", const AttributeValue &v15 = EmptyAttributeValue ());
416 
439  void SetQueueLimits (std::string type,
440  std::string n01 = "", const AttributeValue &v01 = EmptyAttributeValue (),
441  std::string n02 = "", const AttributeValue &v02 = EmptyAttributeValue (),
442  std::string n03 = "", const AttributeValue &v03 = EmptyAttributeValue (),
443  std::string n04 = "", const AttributeValue &v04 = EmptyAttributeValue (),
444  std::string n05 = "", const AttributeValue &v05 = EmptyAttributeValue (),
445  std::string n06 = "", const AttributeValue &v06 = EmptyAttributeValue (),
446  std::string n07 = "", const AttributeValue &v07 = EmptyAttributeValue (),
447  std::string n08 = "", const AttributeValue &v08 = EmptyAttributeValue ());
448 
464  QueueDiscContainer Install (NetDeviceContainer c);
465 
475  QueueDiscContainer Install (Ptr<NetDevice> d);
476 
483  void Uninstall (NetDeviceContainer c);
484 
491  void Uninstall (Ptr<NetDevice> d);
492 
493 private:
495  std::vector<QueueDiscFactory> m_queueDiscFactory;
497  std::vector<Ptr<QueueDisc> > m_queueDiscs;
499  ObjectFactory m_queueLimitsFactory;
500 };
501 
502 } // namespace ns3
503 
504 #endif /* TRAFFIC_CONTROL_HELPER_H */
ns3::TrafficControlHelper::Install
QueueDiscContainer Install(NetDeviceContainer c)
Definition: traffic-control-helper.cc:405
ns3::QueueDiscFactory::QueueDiscFactory
QueueDiscFactory()
Default constructor.
ns3::AttributeValue
Hold a value for an Attribute.
Definition: attribute.h:68
ns3::QueueDiscFactory::m_queueDiscClassesFactory
std::vector< ObjectFactory > m_queueDiscClassesFactory
Vector of factories to create queue disc classes.
Definition: traffic-control-helper.h:103
ns3::TrafficControlHelper::m_queueDiscs
std::vector< Ptr< QueueDisc > > m_queueDiscs
Vector of all the created queue discs.
Definition: traffic-control-helper.h:497
ns3::TrafficControlHelper::Uninstall
void Uninstall(NetDeviceContainer c)
Definition: traffic-control-helper.cc:436
ns3::TrafficControlHelper::AddQueueDiscClasses
ClassIdList AddQueueDiscClasses(uint16_t handle, uint16_t count, std::string type, std::string n01="", const AttributeValue &v01=EmptyAttributeValue(), std::string n02="", const AttributeValue &v02=EmptyAttributeValue(), std::string n03="", const AttributeValue &v03=EmptyAttributeValue(), std::string n04="", const AttributeValue &v04=EmptyAttributeValue(), std::string n05="", const AttributeValue &v05=EmptyAttributeValue(), std::string n06="", const AttributeValue &v06=EmptyAttributeValue(), std::string n07="", const AttributeValue &v07=EmptyAttributeValue(), std::string n08="", const AttributeValue &v08=EmptyAttributeValue())
Helper function used to add the given number of queue disc classes (of the given type and with the gi...
Definition: traffic-control-helper.cc:222
ns3::TrafficControlHelper::AddPacketFilter
void AddPacketFilter(uint16_t handle, std::string type, std::string n01="", const AttributeValue &v01=EmptyAttributeValue(), std::string n02="", const AttributeValue &v02=EmptyAttributeValue(), std::string n03="", const AttributeValue &v03=EmptyAttributeValue(), std::string n04="", const AttributeValue &v04=EmptyAttributeValue(), std::string n05="", const AttributeValue &v05=EmptyAttributeValue(), std::string n06="", const AttributeValue &v06=EmptyAttributeValue(), std::string n07="", const AttributeValue &v07=EmptyAttributeValue(), std::string n08="", const AttributeValue &v08=EmptyAttributeValue())
Helper function used to add a packet filter (of the given type and with the given attributes) to the ...
Definition: traffic-control-helper.cc:194
ns3::QueueDiscFactory::SetChildQueueDisc
void SetChildQueueDisc(uint16_t classId, uint16_t handle)
Set the (child) queue disc to attach to a class.
Definition: traffic-control-helper.cc:60
ns3::QueueDiscContainer
Holds a vector of ns3::QueueDisc pointers.
Definition: queue-disc-container.h:44
ns3::QueueDiscFactory::m_queueDiscFactory
ObjectFactory m_queueDiscFactory
Factory to create this queue disc.
Definition: traffic-control-helper.h:97
ns3::TrafficControlHelper::TrafficControlHelper
TrafficControlHelper()
Create a TrafficControlHelper to make life easier when creating QueueDisc objects.
Definition: traffic-control-helper.cc:106
ns3::EmptyAttributeValue
A class for an empty attribute value.
Definition: attribute.h:232
ns3::NetDeviceContainer
holds a vector of ns3::NetDevice pointers
Definition: net-device-container.h:41
ns3::TrafficControlHelper
Build a set of QueueDisc objects.
Definition: traffic-control-helper.h:118
ns3::TrafficControlHelper::SetQueueLimits
void SetQueueLimits(std::string type, std::string n01="", const AttributeValue &v01=EmptyAttributeValue(), std::string n02="", const AttributeValue &v02=EmptyAttributeValue(), std::string n03="", const AttributeValue &v03=EmptyAttributeValue(), std::string n04="", const AttributeValue &v04=EmptyAttributeValue(), std::string n05="", const AttributeValue &v05=EmptyAttributeValue(), std::string n06="", const AttributeValue &v06=EmptyAttributeValue(), std::string n07="", const AttributeValue &v07=EmptyAttributeValue(), std::string n08="", const AttributeValue &v08=EmptyAttributeValue())
Helper function used to add a queue limits object to the transmission queues of the devices...
Definition: traffic-control-helper.cc:334
ns3::QueueDiscFactory::CreateQueueDisc
Ptr< QueueDisc > CreateQueueDisc(const std::vector< Ptr< QueueDisc > > &queueDiscs)
Create a queue disc with the currently stored configuration.
Definition: traffic-control-helper.cc:68
ns3::TrafficControlHelper::AddChildQueueDiscs
HandleList AddChildQueueDiscs(uint16_t handle, const ClassIdList &classes, std::string type, std::string n01="", const AttributeValue &v01=EmptyAttributeValue(), std::string n02="", const AttributeValue &v02=EmptyAttributeValue(), std::string n03="", const AttributeValue &v03=EmptyAttributeValue(), std::string n04="", const AttributeValue &v04=EmptyAttributeValue(), std::string n05="", const AttributeValue &v05=EmptyAttributeValue(), std::string n06="", const AttributeValue &v06=EmptyAttributeValue(), std::string n07="", const AttributeValue &v07=EmptyAttributeValue(), std::string n08="", const AttributeValue &v08=EmptyAttributeValue(), std::string n09="", const AttributeValue &v09=EmptyAttributeValue(), std::string n10="", const AttributeValue &v10=EmptyAttributeValue(), std::string n11="", const AttributeValue &v11=EmptyAttributeValue(), std::string n12="", const AttributeValue &v12=EmptyAttributeValue(), std::string n13="", const AttributeValue &v13=EmptyAttributeValue(), std::string n14="", const AttributeValue &v14=EmptyAttributeValue(), std::string n15="", const AttributeValue &v15=EmptyAttributeValue())
Helper function used to attach a child queue disc (of the given type and with the given attributes) t...
Definition: traffic-control-helper.cc:304
ns3::TrafficControlHelper::AddChildQueueDisc
uint16_t AddChildQueueDisc(uint16_t handle, uint16_t classId, std::string type, std::string n01="", const AttributeValue &v01=EmptyAttributeValue(), std::string n02="", const AttributeValue &v02=EmptyAttributeValue(), std::string n03="", const AttributeValue &v03=EmptyAttributeValue(), std::string n04="", const AttributeValue &v04=EmptyAttributeValue(), std::string n05="", const AttributeValue &v05=EmptyAttributeValue(), std::string n06="", const AttributeValue &v06=EmptyAttributeValue(), std::string n07="", const AttributeValue &v07=EmptyAttributeValue(), std::string n08="", const AttributeValue &v08=EmptyAttributeValue(), std::string n09="", const AttributeValue &v09=EmptyAttributeValue(), std::string n10="", const AttributeValue &v10=EmptyAttributeValue(), std::string n11="", const AttributeValue &v11=EmptyAttributeValue(), std::string n12="", const AttributeValue &v12=EmptyAttributeValue(), std::string n13="", const AttributeValue &v13=EmptyAttributeValue(), std::string n14="", const AttributeValue &v14=EmptyAttributeValue(), std::string n15="", const AttributeValue &v15=EmptyAttributeValue())
Helper function used to attach a child queue disc (of the given type and with the given attributes) t...
Definition: traffic-control-helper.cc:258
ns3::TrafficControlHelper::ClassIdList
std::vector< uint16_t > ClassIdList
Container type for Class IDs.
Definition: traffic-control-helper.h:261
ns3::QueueDiscFactory::AddQueueDiscClass
uint16_t AddQueueDiscClass(ObjectFactory factory)
Add a factory to create a queue disc class.
Definition: traffic-control-helper.cc:53
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::TrafficControlHelper::SetRootQueueDisc
uint16_t SetRootQueueDisc(std::string type, std::string n01="", const AttributeValue &v01=EmptyAttributeValue(), std::string n02="", const AttributeValue &v02=EmptyAttributeValue(), std::string n03="", const AttributeValue &v03=EmptyAttributeValue(), std::string n04="", const AttributeValue &v04=EmptyAttributeValue(), std::string n05="", const AttributeValue &v05=EmptyAttributeValue(), std::string n06="", const AttributeValue &v06=EmptyAttributeValue(), std::string n07="", const AttributeValue &v07=EmptyAttributeValue(), std::string n08="", const AttributeValue &v08=EmptyAttributeValue(), std::string n09="", const AttributeValue &v09=EmptyAttributeValue(), std::string n10="", const AttributeValue &v10=EmptyAttributeValue(), std::string n11="", const AttributeValue &v11=EmptyAttributeValue(), std::string n12="", const AttributeValue &v12=EmptyAttributeValue(), std::string n13="", const AttributeValue &v13=EmptyAttributeValue(), std::string n14="", const AttributeValue &v14=EmptyAttributeValue(), std::string n15="", const AttributeValue &v15=EmptyAttributeValue())
Helper function used to set a root queue disc of the given type and with the given attributes...
Definition: traffic-control-helper.cc:119
ns3::QueueDiscFactory::m_internalQueuesFactory
std::vector< ObjectFactory > m_internalQueuesFactory
Vector of factories to create internal queues.
Definition: traffic-control-helper.h:99
ns3::QueueDiscFactory::AddInternalQueue
void AddInternalQueue(ObjectFactory factory)
Add a factory to create an internal queue.
Definition: traffic-control-helper.cc:41
ns3::TrafficControlHelper::m_queueLimitsFactory
ObjectFactory m_queueLimitsFactory
Factory to create a queue limits object.
Definition: traffic-control-helper.h:499
ns3::QueueDiscFactory::AddPacketFilter
void AddPacketFilter(ObjectFactory factory)
Add a factory to create a packet filter.
Definition: traffic-control-helper.cc:47
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition: object-factory.h:47
ns3::QueueDiscFactory::m_packetFiltersFactory
std::vector< ObjectFactory > m_packetFiltersFactory
Vector of factories to create packet filters.
Definition: traffic-control-helper.h:101
ns3::TrafficControlHelper::m_queueDiscFactory
std::vector< QueueDiscFactory > m_queueDiscFactory
QueueDisc factory, stores the configuration of all the queue discs.
Definition: traffic-control-helper.h:495
ns3::TrafficControlHelper::AddInternalQueues
void AddInternalQueues(uint16_t handle, uint16_t count, std::string type, std::string n01="", const AttributeValue &v01=EmptyAttributeValue(), std::string n02="", const AttributeValue &v02=EmptyAttributeValue(), std::string n03="", const AttributeValue &v03=EmptyAttributeValue(), std::string n04="", const AttributeValue &v04=EmptyAttributeValue(), std::string n05="", const AttributeValue &v05=EmptyAttributeValue(), std::string n06="", const AttributeValue &v06=EmptyAttributeValue(), std::string n07="", const AttributeValue &v07=EmptyAttributeValue(), std::string n08="", const AttributeValue &v08=EmptyAttributeValue())
Helper function used to add the given number of internal queues (of the given type and with the given...
Definition: traffic-control-helper.cc:161
ns3::QueueDiscFactory::m_classIdChildHandleMap
std::map< uint16_t, uint16_t > m_classIdChildHandleMap
Map storing the associations between class IDs and child queue disc handles.
Definition: traffic-control-helper.h:105
ns3::QueueDiscFactory
This class stores object factories required to create a queue disc and all of its components (packet ...
Definition: traffic-control-helper.h:38
ns3::TrafficControlHelper::Default
static TrafficControlHelper Default(void)
Definition: traffic-control-helper.cc:111
ns3::TrafficControlHelper::HandleList
std::vector< uint16_t > HandleList
Container type for Handlers.
Definition: traffic-control-helper.h:358