A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ipv4-packet-probe.cc
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 #include "ns3/ipv4-packet-probe.h"
25 #include "ns3/object.h"
26 #include "ns3/log.h"
27 #include "ns3/names.h"
28 #include "ns3/config.h"
29 #include "ns3/trace-source-accessor.h"
30 
31 NS_LOG_COMPONENT_DEFINE ("Ipv4PacketProbe");
32 
33 namespace ns3 {
34 
35 NS_OBJECT_ENSURE_REGISTERED (Ipv4PacketProbe)
36  ;
37 
38 TypeId
40 {
41  static TypeId tid = TypeId ("ns3::Ipv4PacketProbe")
42  .SetParent<Probe> ()
43  .AddConstructor<Ipv4PacketProbe> ()
44  .AddTraceSource ( "Output",
45  "The packet plus its IPv4 object and interface that serve as the output for this probe",
47  .AddTraceSource ( "OutputBytes",
48  "The number of bytes in the packet",
50  ;
51  return tid;
52 }
53 
55 {
56  NS_LOG_FUNCTION (this);
57  m_packet = 0;
58  m_packetSizeOld = 0;
59  m_ipv4 = 0;
60  m_interface = 0;
61 }
62 
64 {
65  NS_LOG_FUNCTION (this);
66 }
67 
68 void
69 Ipv4PacketProbe::SetValue (Ptr<const Packet> packet, Ptr<Ipv4> ipv4, uint32_t interface)
70 {
71  NS_LOG_FUNCTION (this << packet << ipv4 << interface);
72  m_packet = packet;
73  m_ipv4 = ipv4;
74  m_interface = interface;
75  m_output (packet, ipv4, interface);
76 
77  uint32_t packetSizeNew = packet->GetSize ();
78  m_outputBytes (m_packetSizeOld, packetSizeNew);
79  m_packetSizeOld = packetSizeNew;
80 }
81 
82 void
83 Ipv4PacketProbe::SetValueByPath (std::string path, Ptr<const Packet> packet, Ptr<Ipv4> ipv4, uint32_t interface)
84 {
85  NS_LOG_FUNCTION (path << packet << ipv4 << interface);
86  Ptr<Ipv4PacketProbe> probe = Names::Find<Ipv4PacketProbe> (path);
87  NS_ASSERT_MSG (probe, "Error: Can't find probe for path " << path);
88  probe->SetValue (packet, ipv4, interface);
89 }
90 
91 bool
92 Ipv4PacketProbe::ConnectByObject (std::string traceSource, Ptr<Object> obj)
93 {
94  NS_LOG_FUNCTION (this << traceSource << obj);
95  NS_LOG_DEBUG ("Name of probe (if any) in names database: " << Names::FindPath (obj));
96  bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::Ipv4PacketProbe::TraceSink, this));
97  return connected;
98 }
99 
100 void
102 {
103  NS_LOG_FUNCTION (this << path);
104  NS_LOG_DEBUG ("Name of probe to search for in config database: " << path);
106 }
107 
108 void
109 Ipv4PacketProbe::TraceSink (Ptr<const Packet> packet, Ptr<Ipv4> ipv4, uint32_t interface)
110 {
111  NS_LOG_FUNCTION (this << packet << ipv4 << interface);
112  if (IsEnabled ())
113  {
114  m_packet = packet;
115  m_ipv4 = ipv4;
116  m_interface = interface;
117  m_output (packet, ipv4, interface);
118 
119  uint32_t packetSizeNew = packet->GetSize ();
120  m_outputBytes (m_packetSizeOld, packetSizeNew);
121  m_packetSizeOld = packetSizeNew;
122  }
123 }
124 
125 } // namespace ns3
#define NS_LOG_FUNCTION(parameters)
Definition: log.h:345
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
NS_OBJECT_ENSURE_REGISTERED(NullMessageSimulatorImpl)
uint32_t GetSize(void) const
Definition: packet.h:650
uint32_t m_interface
The IPv4 interface for the traced packet.
TracedCallback< uint32_t, uint32_t > m_outputBytes
Traced Callback: the previous packet's size and the actual packet's size.
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.
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1238
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
NS_LOG_COMPONENT_DEFINE("Ipv4PacketProbe")
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Definition: object-base.cc:269
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
static std::string FindPath(Ptr< Object > object)
Given a pointer to an object, look to see if that object has a name associated with it and return the...
Definition: names.cc:672
Ptr< Ipv4 > m_ipv4
The IPv4 object for the traced packet.
Ptr< const Packet > m_packet
The traced packet.
#define NS_ASSERT_MSG(condition, message)
Definition: assert.h:86
#define NS_LOG_DEBUG(msg)
Definition: log.h:289
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.
virtual bool IsEnabled(void) const
Definition: probe.cc:64
TracedCallback< Ptr< const Packet >, Ptr< Ipv4 >, uint32_t > m_output
Traced Callback: the packet, the Ipv4 object and the interface.
a unique identifier for an interface.
Definition: type-id.h:49
Base class for probes.
Definition: probe.h:39
TypeId SetParent(TypeId tid)
Definition: type-id.cc:611
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...
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:717