A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
application-packet-probe.h
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
#ifndef APPLICATION_PACKET_PROBE_H
24
#define APPLICATION_PACKET_PROBE_H
25
26
#include "ns3/application.h"
27
#include "ns3/boolean.h"
28
#include "ns3/callback.h"
29
#include "ns3/nstime.h"
30
#include "ns3/object.h"
31
#include "ns3/packet.h"
32
#include "ns3/probe.h"
33
#include "ns3/simulator.h"
34
#include "ns3/traced-value.h"
35
36
namespace
ns3
37
{
38
39
/**
40
* \brief Probe to translate from a TraceSource to two more easily parsed TraceSources.
41
*
42
* This class is designed to probe an underlying ns3 TraceSource
43
* exporting a packet and a socket address. This probe exports a
44
* trace source "Output" with arguments of type Ptr<const Packet> and
45
* const Address&. This probe exports another trace source
46
* "OutputBytes" with arguments of type uint32_t, which is the number
47
* of bytes in the packet. The trace sources emit values when either
48
* the probed trace source emits a new value, or when SetValue () is
49
* called.
50
*/
51
class
ApplicationPacketProbe
:
public
Probe
52
{
53
public
:
54
/**
55
* \brief Get the type ID.
56
* \return the object TypeId
57
*/
58
static
TypeId
GetTypeId
();
59
ApplicationPacketProbe
();
60
~ApplicationPacketProbe
()
override
;
61
62
/**
63
* \brief Set a probe value
64
*
65
* \param packet set the traced packet equal to this
66
* \param address set the socket address for the traced packet equal to this
67
*/
68
void
SetValue
(
Ptr<const Packet>
packet,
const
Address
& address);
69
70
/**
71
* \brief Set a probe value by its name in the Config system
72
*
73
* \param path config path to access the probe
74
* \param packet set the traced packet equal to this
75
* \param address set the socket address for the traced packet equal to this
76
*/
77
static
void
SetValueByPath
(std::string path,
Ptr<const Packet>
packet,
const
Address
& address);
78
79
/**
80
* \brief connect to a trace source attribute provided by a given object
81
*
82
* \param traceSource the name of the attribute TraceSource to connect to
83
* \param obj ns3::Object to connect to
84
* \return true if the trace source was successfully connected
85
*/
86
bool
ConnectByObject
(std::string traceSource,
Ptr<Object>
obj)
override
;
87
88
/**
89
* \brief connect to a trace source provided by a config path
90
*
91
* \param path Config path to bind to
92
*
93
* Note, if an invalid path is provided, the probe will not be connected
94
* to anything.
95
*/
96
void
ConnectByPath
(std::string path)
override
;
97
98
private
:
99
/**
100
* \brief Method to connect to an underlying ns3::TraceSource with
101
* arguments of type Ptr<const Packet> and const Address&
102
*
103
* \param packet the traced packet
104
* \param address the socket address for the traced packet
105
*
106
*/
107
void
TraceSink
(
Ptr<const Packet>
packet,
const
Address
& address);
108
109
/// Output trace, packet and source address
110
TracedCallback<Ptr<const Packet>
,
const
Address
&>
m_output
;
111
/// Output trace, previous packet size and current packet size
112
TracedCallback<uint32_t, uint32_t>
m_outputBytes
;
113
114
/// The traced packet.
115
Ptr<const Packet>
m_packet
;
116
117
/// The socket address for the traced packet.
118
Address
m_address
;
119
120
/// The size of the traced packet.
121
uint32_t
m_packetSizeOld
;
122
};
123
124
}
// namespace ns3
125
126
#endif
// APPLICATION_PACKET_PROBE_H
ns3::Address
a polymophic address class
Definition:
address.h:101
ns3::ApplicationPacketProbe
Probe to translate from a TraceSource to two more easily parsed TraceSources.
Definition:
application-packet-probe.h:52
ns3::ApplicationPacketProbe::m_packet
Ptr< const Packet > m_packet
The traced packet.
Definition:
application-packet-probe.h:115
ns3::ApplicationPacketProbe::ConnectByObject
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
Definition:
application-packet-probe.cc:94
ns3::ApplicationPacketProbe::SetValue
void SetValue(Ptr< const Packet > packet, const Address &address)
Set a probe value.
Definition:
application-packet-probe.cc:70
ns3::ApplicationPacketProbe::ConnectByPath
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
Definition:
application-packet-probe.cc:105
ns3::ApplicationPacketProbe::m_outputBytes
TracedCallback< uint32_t, uint32_t > m_outputBytes
Output trace, previous packet size and current packet size.
Definition:
application-packet-probe.h:112
ns3::ApplicationPacketProbe::ApplicationPacketProbe
ApplicationPacketProbe()
Definition:
application-packet-probe.cc:58
ns3::ApplicationPacketProbe::~ApplicationPacketProbe
~ApplicationPacketProbe() override
Definition:
application-packet-probe.cc:64
ns3::ApplicationPacketProbe::m_output
TracedCallback< Ptr< const Packet >, const Address & > m_output
Output trace, packet and source address.
Definition:
application-packet-probe.h:110
ns3::ApplicationPacketProbe::TraceSink
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...
Definition:
application-packet-probe.cc:114
ns3::ApplicationPacketProbe::m_packetSizeOld
uint32_t m_packetSizeOld
The size of the traced packet.
Definition:
application-packet-probe.h:121
ns3::ApplicationPacketProbe::m_address
Address m_address
The socket address for the traced packet.
Definition:
application-packet-probe.h:118
ns3::ApplicationPacketProbe::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
application-packet-probe.cc:39
ns3::ApplicationPacketProbe::SetValueByPath
static void SetValueByPath(std::string path, Ptr< const Packet > packet, const Address &address)
Set a probe value by its name in the Config system.
Definition:
application-packet-probe.cc:83
ns3::Probe
Base class for probes.
Definition:
probe.h:41
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:77
ns3::TracedCallback
Forward calls to a chain of Callback.
Definition:
traced-callback.h:54
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
uint32_t
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
applications
model
application-packet-probe.h
Generated on Tue May 28 2024 23:34:08 for ns-3 by
1.9.6