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
ipv6-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
* Adapted to Ipv6 by: Tommaso Pecorella (tommaso.pecorella@unifi.it)
22
*/
23
24
#ifndef IPV6_PACKET_PROBE_H
25
#define IPV6_PACKET_PROBE_H
26
27
#include "
ipv6.h
"
28
29
#include "ns3/boolean.h"
30
#include "ns3/callback.h"
31
#include "ns3/nstime.h"
32
#include "ns3/object.h"
33
#include "ns3/packet.h"
34
#include "ns3/probe.h"
35
#include "ns3/simulator.h"
36
#include "ns3/traced-value.h"
37
38
namespace
ns3
39
{
40
41
/**
42
* \ingroup ipv6
43
*
44
* This class is designed to probe an underlying ns3 TraceSource
45
* exporting a packet, an IPv6 object, and an interface. This probe
46
* exports a trace source "Output" with arguments of type Ptr<const Packet>,
47
* Ptr<Ipv6>, and uint32_t. The Output trace source emits a value
48
* when either the trace source emits a new value, or when SetValue ()
49
* is called.
50
*/
51
class
Ipv6PacketProbe
:
public
Probe
52
{
53
public
:
54
/**
55
* \brief Get the type ID.
56
* \return the object TypeId
57
*/
58
static
TypeId
GetTypeId
();
59
60
Ipv6PacketProbe
();
61
~Ipv6PacketProbe
()
override
;
62
63
/**
64
* \brief Set a probe value
65
*
66
* \param packet set the traced packet equal to this
67
* \param ipv6 set the IPv6 object for the traced packet equal to this
68
* \param interface set the IPv6 interface for the traced packet equal to this
69
*/
70
void
SetValue
(
Ptr<const Packet>
packet,
Ptr<Ipv6>
ipv6,
uint32_t
interface);
71
72
/**
73
* \brief Set a probe value by its name in the Config system
74
*
75
* \param path config path to access the probe
76
* \param packet set the traced packet equal to this
77
* \param ipv6 set the IPv6 object for the traced packet equal to this
78
* \param interface set the IPv6 interface for the traced packet equal to this
79
*/
80
static
void
SetValueByPath
(std::string path,
81
Ptr<const Packet>
packet,
82
Ptr<Ipv6>
ipv6,
83
uint32_t
interface);
84
85
/**
86
* \brief connect to a trace source attribute provided by a given object
87
*
88
* \param traceSource the name of the attribute TraceSource to connect to
89
* \param obj ns3::Object to connect to
90
* \return true if the trace source was successfully connected
91
*/
92
bool
ConnectByObject
(std::string traceSource,
Ptr<Object>
obj)
override
;
93
94
/**
95
* \brief connect to a trace source provided by a config path
96
*
97
* \param path Config path to bind to
98
*
99
* Note, if an invalid path is provided, the probe will not be connected
100
* to anything.
101
*/
102
void
ConnectByPath
(std::string path)
override
;
103
104
private
:
105
/**
106
* \brief Method to connect to an underlying ns3::TraceSource with
107
* arguments of type Ptr<const Packet>, Ptr<Ipv6>, and uint32_t
108
*
109
* \param packet the traced packet
110
* \param ipv6 the IPv6 object for the traced packet
111
* \param interface the IPv6 interface for the traced packet
112
*/
113
void
TraceSink
(
Ptr<const Packet>
packet,
Ptr<Ipv6>
ipv6,
uint32_t
interface);
114
115
/// Traced Callback: the packet, the Ipv6 object and the interface.
116
ns3::TracedCallback<Ptr<const Packet>
,
Ptr<Ipv6>
,
uint32_t
>
m_output
;
117
/// Traced Callback: the previous packet's size and the actual packet's size.
118
ns3::TracedCallback<uint32_t, uint32_t>
m_outputBytes
;
119
120
/// The traced packet.
121
Ptr<const Packet>
m_packet
;
122
123
/// The IPv6 object for the traced packet.
124
Ptr<Ipv6>
m_ipv6
;
125
126
/// The IPv6 interface for the traced packet.
127
uint32_t
m_interface
;
128
129
/// The size of the traced packet.
130
uint32_t
m_packetSizeOld
;
131
};
132
133
}
// namespace ns3
134
135
#endif
// IPV6_PACKET_PROBE_H
ns3::Ipv6PacketProbe
This class is designed to probe an underlying ns3 TraceSource exporting a packet, an IPv6 object,...
Definition:
ipv6-packet-probe.h:52
ns3::Ipv6PacketProbe::ConnectByObject
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
Definition:
ipv6-packet-probe.cc:100
ns3::Ipv6PacketProbe::ConnectByPath
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
Definition:
ipv6-packet-probe.cc:111
ns3::Ipv6PacketProbe::Ipv6PacketProbe
Ipv6PacketProbe()
Definition:
ipv6-packet-probe.cc:59
ns3::Ipv6PacketProbe::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
ipv6-packet-probe.cc:40
ns3::Ipv6PacketProbe::TraceSink
void TraceSink(Ptr< const Packet > packet, Ptr< Ipv6 > ipv6, uint32_t interface)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet>,...
Definition:
ipv6-packet-probe.cc:119
ns3::Ipv6PacketProbe::m_ipv6
Ptr< Ipv6 > m_ipv6
The IPv6 object for the traced packet.
Definition:
ipv6-packet-probe.h:124
ns3::Ipv6PacketProbe::~Ipv6PacketProbe
~Ipv6PacketProbe() override
Definition:
ipv6-packet-probe.cc:68
ns3::Ipv6PacketProbe::m_packet
Ptr< const Packet > m_packet
The traced packet.
Definition:
ipv6-packet-probe.h:121
ns3::Ipv6PacketProbe::m_interface
uint32_t m_interface
The IPv6 interface for the traced packet.
Definition:
ipv6-packet-probe.h:127
ns3::Ipv6PacketProbe::m_output
ns3::TracedCallback< Ptr< const Packet >, Ptr< Ipv6 >, uint32_t > m_output
Traced Callback: the packet, the Ipv6 object and the interface.
Definition:
ipv6-packet-probe.h:116
ns3::Ipv6PacketProbe::m_packetSizeOld
uint32_t m_packetSizeOld
The size of the traced packet.
Definition:
ipv6-packet-probe.h:130
ns3::Ipv6PacketProbe::m_outputBytes
ns3::TracedCallback< uint32_t, uint32_t > m_outputBytes
Traced Callback: the previous packet's size and the actual packet's size.
Definition:
ipv6-packet-probe.h:118
ns3::Ipv6PacketProbe::SetValue
void SetValue(Ptr< const Packet > packet, Ptr< Ipv6 > ipv6, uint32_t interface)
Set a probe value.
Definition:
ipv6-packet-probe.cc:74
ns3::Ipv6PacketProbe::SetValueByPath
static void SetValueByPath(std::string path, Ptr< const Packet > packet, Ptr< Ipv6 > ipv6, uint32_t interface)
Set a probe value by its name in the Config system.
Definition:
ipv6-packet-probe.cc:88
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
ipv6.h
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
internet
model
ipv6-packet-probe.h
Generated on Tue May 28 2024 23:36:01 for ns-3 by
1.9.6