A Discrete-Event Network Simulator
API
ipv4-packet-probe.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 Bucknell University
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Authors: L. Felipe Perrone (perrone@bucknell.edu)
19  * Tiago G. Rodrigues (tgr002@bucknell.edu)
20  *
21  * Modified by: Mitch Watrous (watrous@u.washington.edu)
22  */
23 
24 #ifndef IPV4_PACKET_PROBE_H
25 #define IPV4_PACKET_PROBE_H
26 
27 #include "ns3/object.h"
28 #include "ns3/callback.h"
29 #include "ns3/boolean.h"
30 #include "ns3/nstime.h"
31 #include "ns3/packet.h"
32 #include "ns3/ipv4.h"
33 #include "ns3/traced-value.h"
34 #include "ns3/simulator.h"
35 #include "ns3/probe.h"
36 
37 namespace ns3 {
38 
49 class Ipv4PacketProbe : public Probe
50 {
51 public:
56  static TypeId GetTypeId ();
57  Ipv4PacketProbe ();
58  virtual ~Ipv4PacketProbe ();
59 
67  void SetValue (Ptr<const Packet> packet, Ptr<Ipv4> ipv4, uint32_t interface);
68 
77  static void SetValueByPath (std::string path, Ptr<const Packet> packet, Ptr<Ipv4> ipv4, uint32_t interface);
78 
86  virtual bool ConnectByObject (std::string traceSource, Ptr<Object> obj);
87 
96  virtual void ConnectByPath (std::string path);
97 
98 private:
107  void TraceSink (Ptr<const Packet> packet, Ptr<Ipv4> ipv4, uint32_t interface);
108 
113 
116 
119 
121  uint32_t m_interface;
122 
124  uint32_t m_packetSizeOld;
125 };
126 
127 
128 } // namespace ns3
129 
130 #endif // IPV4_PACKET_PROBE_H
This class is designed to probe an underlying ns3 TraceSource exporting a packet, an IPv4 object...
Forward calls to a chain of Callback.
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
uint32_t m_interface
The IPv4 interface for the traced packet.
static TypeId GetTypeId()
Get the type ID.
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.
ns3::TracedCallback< uint32_t, uint32_t > m_outputBytes
Traced Callback: the previous packet&#39;s size and the actual packet&#39;s size.
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< Ipv4 > m_ipv4
The IPv4 object for the traced packet.
Ptr< const Packet > m_packet
The traced packet.
ns3::TracedCallback< Ptr< const Packet >, Ptr< Ipv4 >, uint32_t > m_output
Traced Callback: the packet, the Ipv4 object and the interface.
uint32_t m_packetSizeOld
The size of the traced packet.
void SetValue(Ptr< const Packet > packet, Ptr< Ipv4 > ipv4, uint32_t interface)
Set a probe value.
a unique identifier for an interface.
Definition: type-id.h:58
Base class for probes.
Definition: probe.h:39
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>...