A Discrete-Event Network Simulator
API
application-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 "ns3/application-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
31namespace ns3
32{
33
34NS_LOG_COMPONENT_DEFINE("ApplicationPacketProbe");
35
36NS_OBJECT_ENSURE_REGISTERED(ApplicationPacketProbe);
37
38TypeId
40{
41 static TypeId tid =
42 TypeId("ns3::ApplicationPacketProbe")
44 .SetGroupName("Applications")
45 .AddConstructor<ApplicationPacketProbe>()
46 .AddTraceSource("Output",
47 "The packet plus its socket address that serve "
48 "as the output for this probe",
50 "ns3::Packet::AddressTracedCallback")
51 .AddTraceSource("OutputBytes",
52 "The number of bytes in the packet",
54 "ns3::Packet::SizeTracedCallback");
55 return tid;
56}
57
59{
60 NS_LOG_FUNCTION(this);
61 m_packet = nullptr;
62}
63
65{
66 NS_LOG_FUNCTION(this);
67}
68
69void
71{
72 NS_LOG_FUNCTION(this << packet << address);
73 m_packet = packet;
75 m_output(packet, address);
76
77 uint32_t packetSizeNew = packet->GetSize();
78 m_outputBytes(m_packetSizeOld, packetSizeNew);
79 m_packetSizeOld = packetSizeNew;
80}
81
82void
84 Ptr<const Packet> packet,
85 const Address& address)
86{
87 NS_LOG_FUNCTION(path << packet << address);
88 Ptr<ApplicationPacketProbe> probe = Names::Find<ApplicationPacketProbe>(path);
89 NS_ASSERT_MSG(probe, "Error: Can't find probe for path " << path);
90 probe->SetValue(packet, address);
91}
92
93bool
95{
96 NS_LOG_FUNCTION(this << traceSource << obj);
97 NS_LOG_DEBUG("Name of probe (if any) in names database: " << Names::FindPath(obj));
98 bool connected = obj->TraceConnectWithoutContext(
99 traceSource,
101 return connected;
102}
103
104void
106{
107 NS_LOG_FUNCTION(this << path);
108 NS_LOG_DEBUG("Name of probe to search for in config database: " << path);
111}
112
113void
115{
116 NS_LOG_FUNCTION(this << packet << address);
117 if (IsEnabled())
118 {
119 m_packet = packet;
121 m_output(packet, address);
122
123 uint32_t packetSizeNew = packet->GetSize();
124 m_outputBytes(m_packetSizeOld, packetSizeNew);
125 m_packetSizeOld = packetSizeNew;
126 }
127}
128
129} // namespace ns3
a polymophic address class
Definition: address.h:100
Probe to translate from a TraceSource to two more easily parsed TraceSources.
Ptr< const Packet > m_packet
The traced packet.
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
void SetValue(Ptr< const Packet > packet, const Address &address)
Set a probe value.
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
TracedCallback< uint32_t, uint32_t > m_outputBytes
Output trace, previous packet size and current packet size.
TracedCallback< Ptr< const Packet >, const Address & > m_output
Output trace, packet and source address.
void TraceSink(Ptr< const Packet > packet, const Address &address)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet> and cons...
uint32_t m_packetSizeOld
The size of the traced packet.
Address m_address
The socket address for the traced packet.
static TypeId GetTypeId()
Get the type ID.
static void SetValueByPath(std::string path, Ptr< const Packet > packet, const Address &address)
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:837
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:311
uint32_t GetSize() const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:863
Base class for probes.
Definition: probe.h:40
bool IsEnabled() const override
Definition: probe.cc:65
a unique identifier for an interface.
Definition: type-id.h:60
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:935
#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:951
#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.
address
Definition: first.py:40
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:691