A Discrete-Event Network Simulator
API
ipv4-packet-probe.cc
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2011 Bucknell University
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 * Authors: L. Felipe Perrone (perrone@bucknell.edu)
19 * Tiago G. Rodrigues (tgr002@bucknell.edu)
20 *
21 * Modified by: Mitch Watrous (watrous@u.washington.edu)
22 */
23
24#include "ns3/ipv4-packet-probe.h"
25#include "ns3/object.h"
26#include "ns3/log.h"
27#include "ns3/names.h"
28#include "ns3/config.h"
29#include "ns3/trace-source-accessor.h"
30
31namespace ns3 {
32
33NS_LOG_COMPONENT_DEFINE ("Ipv4PacketProbe");
34
35NS_OBJECT_ENSURE_REGISTERED (Ipv4PacketProbe);
36
37TypeId
39{
40 static TypeId tid = TypeId ("ns3::Ipv4PacketProbe")
41 .SetParent<Probe> ()
42 .SetGroupName ("Internet")
43 .AddConstructor<Ipv4PacketProbe> ()
44 .AddTraceSource ( "Output",
45 "The packet plus its IPv4 object and interface "
46 "that serve as the output for this probe",
48 "ns3::Ipv4L3Protocol::TxRxTracedCallback")
49 .AddTraceSource ( "OutputBytes",
50 "The number of bytes in the packet",
52 "ns3::Packet::SizeTracedCallback")
53 ;
54 return tid;
55}
56
58{
59 NS_LOG_FUNCTION (this);
60 m_packet = 0;
62 m_ipv4 = 0;
63 m_interface = 0;
64}
65
67{
68 NS_LOG_FUNCTION (this);
69}
70
71void
73{
74 NS_LOG_FUNCTION (this << packet << ipv4 << interface);
75 m_packet = packet;
76 m_ipv4 = ipv4;
77 m_interface = interface;
78 m_output (packet, ipv4, interface);
79
80 uint32_t packetSizeNew = packet->GetSize ();
81 m_outputBytes (m_packetSizeOld, packetSizeNew);
82 m_packetSizeOld = packetSizeNew;
83}
84
85void
86Ipv4PacketProbe::SetValueByPath (std::string path, Ptr<const Packet> packet, Ptr<Ipv4> ipv4, uint32_t interface)
87{
88 NS_LOG_FUNCTION (path << packet << ipv4 << interface);
89 Ptr<Ipv4PacketProbe> probe = Names::Find<Ipv4PacketProbe> (path);
90 NS_ASSERT_MSG (probe, "Error: Can't find probe for path " << path);
91 probe->SetValue (packet, ipv4, interface);
92}
93
94bool
95Ipv4PacketProbe::ConnectByObject (std::string traceSource, Ptr<Object> obj)
96{
97 NS_LOG_FUNCTION (this << traceSource << obj);
98 NS_LOG_DEBUG ("Name of probe (if any) in names database: " << Names::FindPath (obj));
99 bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::Ipv4PacketProbe::TraceSink, this));
100 return connected;
101}
102
103void
105{
106 NS_LOG_FUNCTION (this << path);
107 NS_LOG_DEBUG ("Name of probe to search for in config database: " << path);
109}
110
111void
113{
114 NS_LOG_FUNCTION (this << packet << ipv4 << interface);
115 if (IsEnabled ())
116 {
117 m_packet = packet;
118 m_ipv4 = ipv4;
119 m_interface = interface;
120 m_output (packet, ipv4, interface);
121
122 uint32_t packetSizeNew = packet->GetSize ();
123 m_outputBytes (m_packetSizeOld, packetSizeNew);
124 m_packetSizeOld = packetSizeNew;
125 }
126}
127
128} // namespace ns3
This class is designed to probe an underlying ns3 TraceSource exporting a packet, an IPv4 object,...
static void SetValueByPath(std::string path, Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
Set a probe value by its name in the Config system.
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.
ns3::TracedCallback< Ptr< const Packet >, Ptr< Ipv4 >, uint32_t > m_output
Traced Callback: the packet, the Ipv4 object and the interface.
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
void TraceSink(Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>,...
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
uint32_t m_interface
The IPv4 interface for the traced packet.
static TypeId GetTypeId()
Get the type ID.
void SetValue(Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
Set a probe value.
Ptr< Ipv4 > m_ipv4
The IPv4 object for the traced packet.
Ptr< const Packet > m_packet
The traced packet.
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:824
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:364
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:856
Base class for probes.
Definition: probe.h:40
virtual bool IsEnabled(void) const
Definition: probe.cc:64
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
#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:88
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:901
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:273
#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:45
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, Ts... > MakeCallback(R(T::*memPtr)(Ts...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:1648