A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
ipv4-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 IPV4_PACKET_PROBE_H
24
#define IPV4_PACKET_PROBE_H
25
26
#include "ns3/boolean.h"
27
#include "ns3/callback.h"
28
#include "ns3/ipv4.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
49
class
Ipv4PacketProbe
:
public
Probe
50
{
51
public
:
56
static
TypeId
GetTypeId
();
57
Ipv4PacketProbe
();
58
~Ipv4PacketProbe
()
override
;
59
67
void
SetValue
(
Ptr<const Packet>
packet,
Ptr<Ipv4>
ipv4,
uint32_t
interface);
68
77
static
void
SetValueByPath
(std::string
path
,
78
Ptr<const Packet>
packet,
79
Ptr<Ipv4>
ipv4,
80
uint32_t
interface);
81
89
bool
ConnectByObject
(std::string traceSource,
Ptr<Object>
obj)
override
;
90
99
void
ConnectByPath
(std::string
path
)
override
;
100
101
private
:
110
void
TraceSink
(
Ptr<const Packet>
packet,
Ptr<Ipv4>
ipv4,
uint32_t
interface);
111
113
ns3::TracedCallback<Ptr<const Packet>
,
Ptr<Ipv4>
,
uint32_t
>
m_output
;
115
ns3::TracedCallback<uint32_t, uint32_t>
m_outputBytes
;
116
118
Ptr<const Packet>
m_packet
;
119
121
Ptr<Ipv4>
m_ipv4
;
122
124
uint32_t
m_interface
;
125
127
uint32_t
m_packetSizeOld
;
128
};
129
130
}
// namespace ns3
131
132
#endif
// IPV4_PACKET_PROBE_H
ns3::Ipv4PacketProbe
This class is designed to probe an underlying ns3 TraceSource exporting a packet, an IPv4 object,...
Definition:
ipv4-packet-probe.h:50
ns3::Ipv4PacketProbe::ConnectByPath
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
Definition:
ipv4-packet-probe.cc:110
ns3::Ipv4PacketProbe::SetValueByPath
static void SetValueByPath(std::string path, Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
Set a probe value by its name in the Config system.
Definition:
ipv4-packet-probe.cc:87
ns3::Ipv4PacketProbe::m_packetSizeOld
uint32_t m_packetSizeOld
The size of the traced packet.
Definition:
ipv4-packet-probe.h:127
ns3::Ipv4PacketProbe::m_outputBytes
ns3::TracedCallback< uint32_t, uint32_t > m_outputBytes
Traced Callback: the previous packet's size and the actual packet's size.
Definition:
ipv4-packet-probe.h:115
ns3::Ipv4PacketProbe::Ipv4PacketProbe
Ipv4PacketProbe()
Definition:
ipv4-packet-probe.cc:58
ns3::Ipv4PacketProbe::ConnectByObject
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
Definition:
ipv4-packet-probe.cc:99
ns3::Ipv4PacketProbe::~Ipv4PacketProbe
~Ipv4PacketProbe() override
Definition:
ipv4-packet-probe.cc:67
ns3::Ipv4PacketProbe::m_output
ns3::TracedCallback< Ptr< const Packet >, Ptr< Ipv4 >, uint32_t > m_output
Traced Callback: the packet, the Ipv4 object and the interface.
Definition:
ipv4-packet-probe.h:113
ns3::Ipv4PacketProbe::TraceSink
void TraceSink(Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>,...
Definition:
ipv4-packet-probe.cc:118
ns3::Ipv4PacketProbe::m_interface
uint32_t m_interface
The IPv4 interface for the traced packet.
Definition:
ipv4-packet-probe.h:124
ns3::Ipv4PacketProbe::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
ipv4-packet-probe.cc:39
ns3::Ipv4PacketProbe::SetValue
void SetValue(Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
Set a probe value.
Definition:
ipv4-packet-probe.cc:73
ns3::Ipv4PacketProbe::m_ipv4
Ptr< Ipv4 > m_ipv4
The IPv4 object for the traced packet.
Definition:
ipv4-packet-probe.h:121
ns3::Ipv4PacketProbe::m_packet
Ptr< const Packet > m_packet
The traced packet.
Definition:
ipv4-packet-probe.h:118
ns3::Probe
Base class for probes.
Definition:
probe.h:40
ns3::Ptr< const Packet >
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:60
uint32_t
check-style-clang-format.path
path
Definition:
check-style-clang-format.py:679
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
internet
model
ipv4-packet-probe.h
Generated on Tue Nov 1 2022 22:59:55 for ns-3 by
1.9.3