A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
packet-probe.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011 Bucknell University
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Authors: L. Felipe Perrone (perrone@bucknell.edu)
7 * Tiago G. Rodrigues (tgr002@bucknell.edu)
8 *
9 * Modified by: Mitch Watrous (watrous@u.washington.edu)
10 */
11
12#include "packet-probe.h"
13
14#include "ns3/config.h"
15#include "ns3/log.h"
16#include "ns3/names.h"
17#include "ns3/object.h"
18#include "ns3/trace-source-accessor.h"
19
20namespace ns3
21{
22
23NS_LOG_COMPONENT_DEFINE("PacketProbe");
24
26
27TypeId
29{
30 static TypeId tid = TypeId("ns3::PacketProbe")
32 .SetGroupName("Network")
33 .AddConstructor<PacketProbe>()
34 .AddTraceSource("Output",
35 "The packet that serve as the output for this probe",
37 "ns3::Packet::TracedCallback")
38 .AddTraceSource("OutputBytes",
39 "The number of bytes in the packet",
41 "ns3::Packet::SizeTracedCallback");
42 return tid;
43}
44
46{
47 NS_LOG_FUNCTION(this);
48 m_packet = nullptr;
49}
50
55
56void
58{
59 NS_LOG_FUNCTION(this << packet);
60 m_packet = packet;
61 m_output(packet);
62
63 uint32_t packetSizeNew = packet->GetSize();
64 m_outputBytes(m_packetSizeOld, packetSizeNew);
65 m_packetSizeOld = packetSizeNew;
66}
67
68void
70{
71 NS_LOG_FUNCTION(path << packet);
73 NS_ASSERT_MSG(probe, "Error: Can't find probe for path " << path);
74 probe->SetValue(packet);
75}
76
77bool
78PacketProbe::ConnectByObject(std::string traceSource, Ptr<Object> obj)
79{
80 NS_LOG_FUNCTION(this << traceSource << obj);
81 NS_LOG_DEBUG("Name of probe (if any) in names database: " << Names::FindPath(obj));
82 bool connected =
83 obj->TraceConnectWithoutContext(traceSource,
85 return connected;
86}
87
88void
90{
91 NS_LOG_FUNCTION(this << path);
92 NS_LOG_DEBUG("Name of probe to search for in config database: " << path);
94}
95
96void
98{
99 NS_LOG_FUNCTION(this << packet);
100 if (IsEnabled())
101 {
102 m_packet = packet;
103 m_output(packet);
104
105 uint32_t packetSizeNew = packet->GetSize();
106 m_outputBytes(m_packetSizeOld, packetSizeNew);
107 m_packetSizeOld = packetSizeNew;
108 }
109}
110
111} // namespace ns3
static Ptr< T > Find(std::string path)
Given a name path string, look to see if there's an object in the system with that associated to it.
Definition names.h:443
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:825
This class is designed to probe an underlying ns3 TraceSource exporting a packet.
~PacketProbe() override
TracedCallback< uint32_t, uint32_t > m_outputBytes
Traced callback: size of previous packet receive, size of actual packet received.
static TypeId GetTypeId()
Get the type ID.
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
static void SetValueByPath(std::string path, Ptr< const Packet > packet)
Set a probe value by its name in the Config system.
uint32_t m_packetSizeOld
The size of the traced packet.
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.
void SetValue(Ptr< const Packet > packet)
Set a probe value.
Ptr< const Packet > m_packet
The traced packet.
Base class for probes.
Definition probe.h:30
bool IsEnabled() const override
Definition probe.cc:54
Smart pointer class similar to boost::intrusive_ptr.
a unique identifier for an interface.
Definition type-id.h:48
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition type-id.cc:1001
#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:75
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition config.cc:943
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition log.h:191
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition log.h:257
#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:35
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:684