A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ipv6-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  * Adapted to Ipv6 by: Tommaso Pecorella (tommaso.pecorella@unifi.it)
23  */
24 
25 #include "ns3/ipv6-packet-probe.h"
26 #include "ns3/object.h"
27 #include "ns3/log.h"
28 #include "ns3/names.h"
29 #include "ns3/config.h"
30 #include "ns3/trace-source-accessor.h"
31 
32 NS_LOG_COMPONENT_DEFINE ("Ipv6PacketProbe");
33 
34 namespace ns3 {
35 
36 NS_OBJECT_ENSURE_REGISTERED (Ipv6PacketProbe)
37  ;
38 
39 TypeId
41 {
42  static TypeId tid = TypeId ("ns3::Ipv6PacketProbe")
43  .SetParent<Probe> ()
44  .AddConstructor<Ipv6PacketProbe> ()
45  .AddTraceSource ( "Output",
46  "The packet plus its IPv6 object and interface that serve as the output for this probe",
48  .AddTraceSource ( "OutputBytes",
49  "The number of bytes in the packet",
51  ;
52  return tid;
53 }
54 
56 {
57  NS_LOG_FUNCTION (this);
58  m_packet = 0;
59  m_packetSizeOld = 0;
60  m_ipv6 = 0;
61  m_interface = 0;
62 }
63 
65 {
66  NS_LOG_FUNCTION (this);
67 }
68 
69 void
70 Ipv6PacketProbe::SetValue (Ptr<const Packet> packet, Ptr<Ipv6> ipv6, uint32_t interface)
71 {
72  NS_LOG_FUNCTION (this << packet << ipv6 << interface);
73  m_packet = packet;
74  m_ipv6 = ipv6;
75  m_interface = interface;
76  m_output (packet, ipv6, interface);
77 
78  uint32_t packetSizeNew = packet->GetSize ();
79  m_outputBytes (m_packetSizeOld, packetSizeNew);
80  m_packetSizeOld = packetSizeNew;
81 }
82 
83 void
84 Ipv6PacketProbe::SetValueByPath (std::string path, Ptr<const Packet> packet, Ptr<Ipv6> ipv6, uint32_t interface)
85 {
86  NS_LOG_FUNCTION (path << packet << ipv6 << interface);
87  Ptr<Ipv6PacketProbe> probe = Names::Find<Ipv6PacketProbe> (path);
88  NS_ASSERT_MSG (probe, "Error: Can't find probe for path " << path);
89  probe->SetValue (packet, ipv6, interface);
90 }
91 
92 bool
93 Ipv6PacketProbe::ConnectByObject (std::string traceSource, Ptr<Object> obj)
94 {
95  NS_LOG_FUNCTION (this << traceSource << obj);
96  NS_LOG_DEBUG ("Name of probe (if any) in names database: " << Names::FindPath (obj));
97  bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::Ipv6PacketProbe::TraceSink, this));
98  return connected;
99 }
100 
101 void
103 {
104  NS_LOG_FUNCTION (this << path);
105  NS_LOG_DEBUG ("Name of probe to search for in config database: " << path);
107 }
108 
109 void
110 Ipv6PacketProbe::TraceSink (Ptr<const Packet> packet, Ptr<Ipv6> ipv6, uint32_t interface)
111 {
112  NS_LOG_FUNCTION (this << packet << ipv6 << interface);
113  if (IsEnabled ())
114  {
115  m_packet = packet;
116  m_ipv6 = ipv6;
117  m_interface = interface;
118  m_output (packet, ipv6, interface);
119 
120  uint32_t packetSizeNew = packet->GetSize ();
121  m_outputBytes (m_packetSizeOld, packetSizeNew);
122  m_packetSizeOld = packetSizeNew;
123  }
124 }
125 
126 } // namespace ns3
NS_LOG_COMPONENT_DEFINE("Ipv6PacketProbe")
#define NS_LOG_FUNCTION(parameters)
Definition: log.h:345
NS_OBJECT_ENSURE_REGISTERED(NullMessageSimulatorImpl)
uint32_t GetSize(void) const
Definition: packet.h:650
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.
TracedCallback< Ptr< const Packet >, Ptr< Ipv6 >, uint32_t > m_output
Traced Callback: the packet, the Ipv6 object and the interface.
static TypeId GetTypeId()
Get the type ID.
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
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Definition: object-base.cc:269
uint32_t m_packetSizeOld
The size of the traced packet.
Ptr< Ipv6 > m_ipv6
The IPv6 object for the traced packet.
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< 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
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...
virtual bool IsEnabled(void) const
Definition: probe.cc:64
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
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.
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:717
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
uint32_t m_interface
The IPv6 interface for the traced packet.