A Discrete-Event Network Simulator
API
v4traceroute-helper.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 Ritsumeikan University, Shiga, Japan
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  *
18  * Author: Alberto Gallegos Ramonet <ramonet@fc.ritsumei.ac.jp>
19  *
20  */
21 
22 #include "v4traceroute-helper.h"
23 
24 #include "ns3/names.h"
25 #include "ns3/v4traceroute.h"
26 
27 namespace ns3
28 {
29 
31 {
32  m_factory.SetTypeId("ns3::V4TraceRoute");
33  m_factory.Set("Remote", Ipv4AddressValue(remote));
34 }
35 
36 void
37 V4TraceRouteHelper::SetAttribute(std::string name, const AttributeValue& value)
38 {
39  m_factory.Set(name, value);
40 }
41 
44 {
45  return ApplicationContainer(InstallPriv(node));
46 }
47 
49 V4TraceRouteHelper::Install(std::string nodeName) const
50 {
51  Ptr<Node> node = Names::Find<Node>(nodeName);
52  return ApplicationContainer(InstallPriv(node));
53 }
54 
57 {
59  for (auto i = c.Begin(); i != c.End(); ++i)
60  {
61  apps.Add(InstallPriv(*i));
62  }
63 
64  return apps;
65 }
66 
69 {
71  node->AddApplication(app);
72 
73  return app;
74 }
75 
76 void
78 {
79  Ptr<V4TraceRoute> trace;
80 
81  for (uint32_t i = 0; i < node->GetNApplications(); ++i)
82  {
83  trace = node->GetApplication(i)->GetObject<V4TraceRoute>();
84  if (trace)
85  {
86  *stream->GetStream() << "Tracing Route from Node " << node->GetId() << "\n";
87  trace->Print(stream);
88  return;
89  }
90  }
91  NS_ASSERT_MSG(false, "No V4TraceRoute application found in node " << node->GetId());
92 }
93 
94 } // namespace ns3
holds a vector of ns3::Application pointers.
void Add(ApplicationContainer other)
Append the contents of another ApplicationContainer to the end of this container.
Hold a value for an Attribute.
Definition: attribute.h:70
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:42
keep track of a set of node pointers.
Iterator End() const
Get an iterator which indicates past-the-last Node in the container.
Iterator Begin() const
Get an iterator which refers to the first Node in the container.
uint32_t GetNApplications() const
Definition: node.cc:190
Ptr< Application > GetApplication(uint32_t index) const
Retrieve the index-th Application associated to this node.
Definition: node.cc:180
uint32_t AddApplication(Ptr< Application > application)
Associate an Application to this Node.
Definition: node.cc:169
uint32_t GetId() const
Definition: node.cc:117
Ptr< Object > Create() const
Create an Object instance of the configured TypeId.
void Set(const std::string &name, const AttributeValue &value, Args &&... args)
Set an attribute to be set during construction.
void SetTypeId(TypeId tid)
Set the TypeId of the Objects to be created by this factory.
Ptr< T > GetObject() const
Get a pointer to the requested aggregated Object.
Definition: object.h:471
std::ostream * GetStream()
Return a pointer to an ostream previously set in the wrapper.
static void PrintTraceRouteAt(Ptr< Node > node, Ptr< OutputStreamWrapper > stream)
Print the resulting trace routes from given node.
ApplicationContainer Install(NodeContainer nodes) const
Install a TraceRoute application on each Node in the provided NodeContainer.
ObjectFactory m_factory
Object factory.
Ptr< Application > InstallPriv(Ptr< Node > node) const
Do the actual application installation in the node.
V4TraceRouteHelper(Ipv4Address remote)
Create a V4TraceRouteHelper which is used to make life easier for people wanting to use TraceRoute.
void SetAttribute(std::string name, const AttributeValue &value)
Configure traceRoute applications attribute.
Traceroute application sends one ICMP ECHO request with TTL=1, and after receiving an ICMP TIME EXCEE...
Definition: v4traceroute.h:51
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Definition: assert.h:86
Every class exported by the ns3 library is enclosed in the ns3 namespace.