A Discrete-Event Network Simulator
API
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  */
22 
23 #include "packet-probe.h"
24 
25 #include "ns3/config.h"
26 #include "ns3/log.h"
27 #include "ns3/names.h"
28 #include "ns3/object.h"
29 #include "ns3/trace-source-accessor.h"
30 
31 namespace ns3
32 {
33 
34 NS_LOG_COMPONENT_DEFINE("PacketProbe");
35 
36 NS_OBJECT_ENSURE_REGISTERED(PacketProbe);
37 
38 TypeId
40 {
41  static TypeId tid = TypeId("ns3::PacketProbe")
42  .SetParent<Probe>()
43  .SetGroupName("Network")
44  .AddConstructor<PacketProbe>()
45  .AddTraceSource("Output",
46  "The packet that serve as the output for this probe",
48  "ns3::Packet::TracedCallback")
49  .AddTraceSource("OutputBytes",
50  "The number of bytes in the packet",
52  "ns3::Packet::SizeTracedCallback");
53  return tid;
54 }
55 
57 {
58  NS_LOG_FUNCTION(this);
59  m_packet = nullptr;
60 }
61 
63 {
64  NS_LOG_FUNCTION(this);
65 }
66 
67 void
69 {
70  NS_LOG_FUNCTION(this << packet);
71  m_packet = packet;
72  m_output(packet);
73 
74  uint32_t packetSizeNew = packet->GetSize();
75  m_outputBytes(m_packetSizeOld, packetSizeNew);
76  m_packetSizeOld = packetSizeNew;
77 }
78 
79 void
81 {
82  NS_LOG_FUNCTION(path << packet);
83  Ptr<PacketProbe> probe = Names::Find<PacketProbe>(path);
84  NS_ASSERT_MSG(probe, "Error: Can't find probe for path " << path);
85  probe->SetValue(packet);
86 }
87 
88 bool
89 PacketProbe::ConnectByObject(std::string traceSource, Ptr<Object> obj)
90 {
91  NS_LOG_FUNCTION(this << traceSource << obj);
92  NS_LOG_DEBUG("Name of probe (if any) in names database: " << Names::FindPath(obj));
93  bool connected =
94  obj->TraceConnectWithoutContext(traceSource,
96  return connected;
97 }
98 
99 void
100 PacketProbe::ConnectByPath(std::string path)
101 {
102  NS_LOG_FUNCTION(this << path);
103  NS_LOG_DEBUG("Name of probe to search for in config database: " << path);
105 }
106 
107 void
109 {
110  NS_LOG_FUNCTION(this << packet);
111  if (IsEnabled())
112  {
113  m_packet = packet;
114  m_output(packet);
115 
116  uint32_t packetSizeNew = packet->GetSize();
117  m_outputBytes(m_packetSizeOld, packetSizeNew);
118  m_packetSizeOld = packetSizeNew;
119  }
120 }
121 
122 } // namespace ns3
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
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:315
uint32_t GetSize() const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:861
This class is designed to probe an underlying ns3 TraceSource exporting a packet.
Definition: packet-probe.h:48
~PacketProbe() override
Definition: packet-probe.cc:62
TracedCallback< uint32_t, uint32_t > m_outputBytes
Traced callback: size of previous packet receive, size of actual packet received.
Definition: packet-probe.h:104
static TypeId GetTypeId()
Get the type ID.
Definition: packet-probe.cc:39
void TraceSink(Ptr< const Packet > packet)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
Definition: packet-probe.cc:89
static void SetValueByPath(std::string path, Ptr< const Packet > packet)
Set a probe value by its name in the Config system.
Definition: packet-probe.cc:80
uint32_t m_packetSizeOld
The size of the traced packet.
Definition: packet-probe.h:110
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
TracedCallback< Ptr< const Packet > > m_output
Traced callback: packet received.
Definition: packet-probe.h:102
void SetValue(Ptr< const Packet > packet)
Set a probe value.
Definition: packet-probe.cc:68
Ptr< const Packet > m_packet
The traced packet.
Definition: packet-probe.h:107
Base class for probes.
Definition: probe.h:41
bool IsEnabled() const override
Definition: probe.cc:65
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:931
#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:950
#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:704