A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
application-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
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("ApplicationPacketProbe");
24
25NS_OBJECT_ENSURE_REGISTERED(ApplicationPacketProbe);
26
27TypeId
29{
30 static TypeId tid =
31 TypeId("ns3::ApplicationPacketProbe")
33 .SetGroupName("Applications")
34 .AddConstructor<ApplicationPacketProbe>()
35 .AddTraceSource("Output",
36 "The packet plus its socket address that serve "
37 "as the output for this probe",
39 "ns3::Packet::AddressTracedCallback")
40 .AddTraceSource("OutputBytes",
41 "The number of bytes in the packet",
43 "ns3::Packet::SizeTracedCallback");
44 return tid;
45}
46
52
57
58void
60{
61 NS_LOG_FUNCTION(this << packet << address);
62 m_packet = packet;
63 m_address = address;
64 m_output(packet, address);
65
66 uint32_t packetSizeNew = packet->GetSize();
67 m_outputBytes(m_packetSizeOld, packetSizeNew);
68 m_packetSizeOld = packetSizeNew;
69}
70
71void
73 Ptr<const Packet> packet,
74 const Address& address)
75{
76 NS_LOG_FUNCTION(path << packet << address);
78 NS_ASSERT_MSG(probe, "Error: Can't find probe for path " << path);
79 probe->SetValue(packet, address);
80}
81
82bool
84{
85 NS_LOG_FUNCTION(this << traceSource << obj);
86 NS_LOG_DEBUG("Name of probe (if any) in names database: " << Names::FindPath(obj));
87 bool connected = obj->TraceConnectWithoutContext(
88 traceSource,
90 return connected;
91}
92
93void
95{
96 NS_LOG_FUNCTION(this << path);
97 NS_LOG_DEBUG("Name of probe to search for in config database: " << path);
100}
101
102void
104{
105 NS_LOG_FUNCTION(this << packet << address);
106 if (IsEnabled())
107 {
108 m_packet = packet;
109 m_address = address;
110 m_output(packet, address);
111
112 uint32_t packetSizeNew = packet->GetSize();
113 m_outputBytes(m_packetSizeOld, packetSizeNew);
114 m_packetSizeOld = packetSizeNew;
115 }
116}
117
118} // namespace ns3
a polymophic address class
Definition address.h:90
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 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
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