A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ipv6-packet-probe.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011 Bucknell University
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: L. Felipe Perrone (perrone@bucknell.edu)
18 * Tiago G. Rodrigues (tgr002@bucknell.edu)
19 *
20 * Modified by: Mitch Watrous (watrous@u.washington.edu)
21 * Adapted to Ipv6 by: Tommaso Pecorella (tommaso.pecorella@unifi.it)
22 */
23
24#include "ipv6-packet-probe.h"
25
26#include "ns3/config.h"
27#include "ns3/log.h"
28#include "ns3/names.h"
29#include "ns3/object.h"
30#include "ns3/trace-source-accessor.h"
31
32namespace ns3
33{
34
35NS_LOG_COMPONENT_DEFINE("Ipv6PacketProbe");
36
37NS_OBJECT_ENSURE_REGISTERED(Ipv6PacketProbe);
38
39TypeId
41{
42 static TypeId tid =
43 TypeId("ns3::Ipv6PacketProbe")
45 .SetGroupName("Internet")
46 .AddConstructor<Ipv6PacketProbe>()
47 .AddTraceSource("Output",
48 "The packet plus its IPv6 object and interface "
49 "that serve as the output for this probe",
51 "ns3::Ipv6L3Protocol::TxRxTracedCallback")
52 .AddTraceSource("OutputBytes",
53 "The number of bytes in the packet",
55 "ns3::Packet::SizeTracedCallback");
56 return tid;
57}
58
60{
61 NS_LOG_FUNCTION(this);
62 m_packet = nullptr;
64 m_ipv6 = nullptr;
65 m_interface = 0;
66}
67
69{
70 NS_LOG_FUNCTION(this);
71}
72
73void
75{
76 NS_LOG_FUNCTION(this << packet << ipv6 << interface);
77 m_packet = packet;
78 m_ipv6 = ipv6;
79 m_interface = interface;
80 m_output(packet, ipv6, interface);
81
82 uint32_t packetSizeNew = packet->GetSize();
83 m_outputBytes(m_packetSizeOld, packetSizeNew);
84 m_packetSizeOld = packetSizeNew;
85}
86
87void
89 Ptr<const Packet> packet,
90 Ptr<Ipv6> ipv6,
91 uint32_t interface)
92{
93 NS_LOG_FUNCTION(path << packet << ipv6 << interface);
94 Ptr<Ipv6PacketProbe> probe = Names::Find<Ipv6PacketProbe>(path);
95 NS_ASSERT_MSG(probe, "Error: Can't find probe for path " << path);
96 probe->SetValue(packet, ipv6, interface);
97}
98
99bool
101{
102 NS_LOG_FUNCTION(this << traceSource << obj);
103 NS_LOG_DEBUG("Name of probe (if any) in names database: " << Names::FindPath(obj));
104 bool connected =
105 obj->TraceConnectWithoutContext(traceSource,
107 return connected;
108}
109
110void
112{
113 NS_LOG_FUNCTION(this << path);
114 NS_LOG_DEBUG("Name of probe to search for in config database: " << path);
116}
117
118void
120{
121 NS_LOG_FUNCTION(this << packet << ipv6 << interface);
122 if (IsEnabled())
123 {
124 m_packet = packet;
125 m_ipv6 = ipv6;
126 m_interface = interface;
127 m_output(packet, ipv6, interface);
128
129 uint32_t packetSizeNew = packet->GetSize();
130 m_outputBytes(m_packetSizeOld, packetSizeNew);
131 m_packetSizeOld = packetSizeNew;
132 }
133}
134
135} // namespace ns3
This class is designed to probe an underlying ns3 TraceSource exporting a packet, an IPv6 object,...
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
static TypeId GetTypeId()
Get the type ID.
void TraceSink(Ptr< const Packet > packet, Ptr< Ipv6 > ipv6, uint32_t interface)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>,...
Ptr< Ipv6 > m_ipv6
The IPv6 object for the traced packet.
Ptr< const Packet > m_packet
The traced packet.
uint32_t m_interface
The IPv6 interface for the traced packet.
ns3::TracedCallback< Ptr< const Packet >, Ptr< Ipv6 >, uint32_t > m_output
Traced Callback: the packet, the Ipv6 object and the interface.
uint32_t m_packetSizeOld
The size of the traced packet.
ns3::TracedCallback< uint32_t, uint32_t > m_outputBytes
Traced Callback: the previous packet's size and the actual packet's size.
void SetValue(Ptr< const Packet > packet, Ptr< Ipv6 > ipv6, uint32_t interface)
Set a probe value.
static void SetValueByPath(std::string path, Ptr< const Packet > packet, Ptr< Ipv6 > ipv6, uint32_t interface)
Set a probe value by its name in the Config system.
static std::string FindPath(Ptr< Object > object)
Given a pointer to an object, look to see if that object has a name associated with it and return the...
Definition: names.cc:836
Base class for probes.
Definition: probe.h:41
bool IsEnabled() const override
Definition: probe.cc:65
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:932
#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
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:954
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:268
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:46
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:706