A Discrete-Event Network Simulator
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();
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 
116 
119 
122 
124  uint32_t m_interface;
125 
127  uint32_t m_packetSizeOld;
128 };
129 
130 } // namespace ns3
131 
132 #endif // IPV4_PACKET_PROBE_H
This class is designed to probe an underlying ns3 TraceSource exporting a packet, an IPv4 object,...
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
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.
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.
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
ns3::TracedCallback< Ptr< const Packet >, Ptr< Ipv4 >, uint32_t > m_output
Traced Callback: the packet, the Ipv4 object and the interface.
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>,...
uint32_t m_interface
The IPv4 interface for the traced packet.
static TypeId GetTypeId()
Get the type ID.
void SetValue(Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
Set a probe value.
Ptr< Ipv4 > m_ipv4
The IPv4 object for the traced packet.
Ptr< const Packet > m_packet
The traced packet.
Base class for probes.
Definition: probe.h:40
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:60
Every class exported by the ns3 library is enclosed in the ns3 namespace.