A Discrete-Event Network Simulator
API
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 
51 class Ipv6PacketProbe : public Probe
52 {
53  public:
58  static TypeId GetTypeId();
59 
61  ~Ipv6PacketProbe() override;
62 
70  void SetValue(Ptr<const Packet> packet, Ptr<Ipv6> ipv6, uint32_t interface);
71 
80  static void SetValueByPath(std::string path,
81  Ptr<const Packet> packet,
82  Ptr<Ipv6> ipv6,
83  uint32_t interface);
84 
92  bool ConnectByObject(std::string traceSource, Ptr<Object> obj) override;
93 
102  void ConnectByPath(std::string path) override;
103 
104  private:
113  void TraceSink(Ptr<const Packet> packet, Ptr<Ipv6> ipv6, uint32_t interface);
114 
119 
122 
125 
127  uint32_t m_interface;
128 
130  uint32_t m_packetSizeOld;
131 };
132 
133 } // namespace ns3
134 
135 #endif // IPV6_PACKET_PROBE_H
This class is designed to probe an underlying ns3 TraceSource exporting a packet, an IPv6 object,...
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
static TypeId GetTypeId()
Get the type ID.
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>,...
Ptr< Ipv6 > m_ipv6
The IPv6 object for the traced packet.
Ptr< const Packet > m_packet
The traced packet.
uint32_t m_interface
The IPv6 interface for the traced packet.
ns3::TracedCallback< Ptr< const Packet >, Ptr< Ipv6 >, uint32_t > m_output
Traced Callback: the packet, the Ipv6 object and the interface.
uint32_t m_packetSizeOld
The size of the traced packet.
ns3::TracedCallback< uint32_t, uint32_t > m_outputBytes
Traced Callback: the previous packet's size and the actual packet's size.
void SetValue(Ptr< const Packet > packet, Ptr< Ipv6 > ipv6, uint32_t interface)
Set a probe value.
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.
Base class for probes.
Definition: probe.h:41
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.