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
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 PACKET_PROBE_H
24
#define PACKET_PROBE_H
25
26
#include "ns3/boolean.h"
27
#include "ns3/callback.h"
28
#include "ns3/nstime.h"
29
#include "ns3/object.h"
30
#include "ns3/packet.h"
31
#include "ns3/probe.h"
32
#include "ns3/simulator.h"
33
#include "ns3/traced-value.h"
34
35
namespace
ns3
36
{
37
38
/**
39
* This class is designed to probe an underlying ns3 TraceSource
40
* exporting a packet. This probe exports a trace source "Output"
41
* with argument of type Ptr<const Packet>. This probe exports
42
* another trace source "OutputBytes" with arguments of type uint32_t,
43
* which is the number of bytes in the packet. The trace sources emit
44
* values when either the probed trace source emits a new value, or
45
* when SetValue () is called.
46
*/
47
class
PacketProbe
:
public
Probe
48
{
49
public
:
50
/**
51
* \brief Get the type ID.
52
* \return the object TypeId
53
*/
54
static
TypeId
GetTypeId
();
55
PacketProbe
();
56
~PacketProbe
()
override
;
57
58
/**
59
* \brief Set a probe value
60
*
61
* \param packet set the traced packet equal to this
62
*/
63
void
SetValue
(
Ptr<const Packet>
packet);
64
65
/**
66
* \brief Set a probe value by its name in the Config system
67
*
68
* \param path config path to access the probe
69
* \param packet set the traced packet equal to this
70
*/
71
static
void
SetValueByPath
(std::string path,
Ptr<const Packet>
packet);
72
73
/**
74
* \brief connect to a trace source attribute provided by a given object
75
*
76
* \param traceSource the name of the attribute TraceSource to connect to
77
* \param obj ns3::Object to connect to
78
* \return true if the trace source was successfully connected
79
*/
80
bool
ConnectByObject
(std::string traceSource,
Ptr<Object>
obj)
override
;
81
82
/**
83
* \brief connect to a trace source provided by a config path
84
*
85
* \param path Config path to bind to
86
*
87
* Note, if an invalid path is provided, the probe will not be connected
88
* to anything.
89
*/
90
void
ConnectByPath
(std::string path)
override
;
91
92
private
:
93
/**
94
* \brief Method to connect to an underlying ns3::TraceSource with
95
* arguments of type Ptr<const Packet>
96
*
97
* \param packet the traced packet
98
*/
99
void
TraceSink
(
Ptr<const Packet>
packet);
100
101
/// Traced callback: packet received
102
TracedCallback<Ptr<const Packet>
>
m_output
;
103
/// Traced callback: size of previous packet receive, size of actual packet received
104
TracedCallback<uint32_t, uint32_t>
m_outputBytes
;
105
106
/// The traced packet.
107
Ptr<const Packet>
m_packet
;
108
109
/// The size of the traced packet.
110
uint32_t
m_packetSizeOld
;
111
};
112
113
}
// namespace ns3
114
115
#endif
// PACKET_PROBE_H
ns3::PacketProbe
This class is designed to probe an underlying ns3 TraceSource exporting a packet.
Definition:
packet-probe.h:48
ns3::PacketProbe::~PacketProbe
~PacketProbe() override
Definition:
packet-probe.cc:62
ns3::PacketProbe::m_outputBytes
TracedCallback< uint32_t, uint32_t > m_outputBytes
Traced callback: size of previous packet receive, size of actual packet received.
Definition:
packet-probe.h:104
ns3::PacketProbe::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
packet-probe.cc:39
ns3::PacketProbe::TraceSink
void TraceSink(Ptr< const Packet > packet)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>
Definition:
packet-probe.cc:108
ns3::PacketProbe::ConnectByObject
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
ns3::PacketProbe::PacketProbe
PacketProbe()
Definition:
packet-probe.cc:56
ns3::PacketProbe::SetValueByPath
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
ns3::PacketProbe::m_packetSizeOld
uint32_t m_packetSizeOld
The size of the traced packet.
Definition:
packet-probe.h:110
ns3::PacketProbe::ConnectByPath
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
Definition:
packet-probe.cc:100
ns3::PacketProbe::m_output
TracedCallback< Ptr< const Packet > > m_output
Traced callback: packet received.
Definition:
packet-probe.h:102
ns3::PacketProbe::SetValue
void SetValue(Ptr< const Packet > packet)
Set a probe value.
Definition:
packet-probe.cc:68
ns3::PacketProbe::m_packet
Ptr< const Packet > m_packet
The traced packet.
Definition:
packet-probe.h:107
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
network
utils
packet-probe.h
Generated on Tue May 28 2024 23:38:46 for ns-3 by
1.9.6