A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 PACKET_PROBE_H
25 #define 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/traced-value.h"
33 #include "ns3/simulator.h"
34 #include "ns3/probe.h"
35 
36 namespace ns3 {
37 
47 class PacketProbe : public Probe
48 {
49 public:
50  static TypeId GetTypeId ();
51  PacketProbe ();
52  virtual ~PacketProbe ();
53 
59  void SetValue (Ptr<const Packet> packet);
60 
67  static void SetValueByPath (std::string path, Ptr<const Packet> packet);
68 
76  virtual bool ConnectByObject (std::string traceSource, Ptr<Object> obj);
77 
86  virtual void ConnectByPath (std::string path);
87 
88 private:
97  void TraceSink (Ptr<const Packet> packet);
98 
99  TracedCallback<Ptr<const Packet> > m_output;
100  TracedCallback<uint32_t, uint32_t> m_outputBytes;
101 
103  Ptr<const Packet> m_packet;
104 
106  uint32_t m_packetSizeOld;
107 };
108 
109 
110 } // namespace ns3
111 
112 #endif // PACKET_PROBE_H
ns3::PacketProbe::GetTypeId
static TypeId GetTypeId()
Definition: packet-probe.cc:38
ns3::PacketProbe::TraceSink
void TraceSink(Ptr< const Packet > packet)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr ...
Definition: packet-probe.cc:103
ns3::TracedCallback
forward calls to a chain of CallbackAn ns3::TracedCallback has almost exactly the same API as a norma...
Definition: traced-callback.h:43
ns3::PacketProbe::SetValueByPath
static void SetValueByPath(std::string path, Ptr< const Packet > packet)
Set a probe value by its name in the Config system.
Definition: packet-probe.cc:77
ns3::PacketProbe::m_outputBytes
TracedCallback< uint32_t, uint32_t > m_outputBytes
Definition: packet-probe.h:100
ns3::PacketProbe::m_output
TracedCallback< Ptr< const Packet > > m_output
Definition: packet-probe.h:99
ns3::PacketProbe::ConnectByObject
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
Definition: packet-probe.cc:86
ns3::PacketProbe::ConnectByPath
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
Definition: packet-probe.cc:95
ns3::PacketProbe::m_packet
Ptr< const Packet > m_packet
The traced packet.
Definition: packet-probe.h:103
ns3::PacketProbe::~PacketProbe
virtual ~PacketProbe()
Definition: packet-probe.cc:59
ns3::PacketProbe::SetValue
void SetValue(Ptr< const Packet > packet)
Set a probe value.
Definition: packet-probe.cc:65
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:49
ns3::PacketProbe::m_packetSizeOld
uint32_t m_packetSizeOld
The size of the traced packet.
Definition: packet-probe.h:106