A Discrete-Event Network Simulator
API
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/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 namespace ns3 {
32 
33 NS_LOG_COMPONENT_DEFINE ("PacketProbe");
34 
35 NS_OBJECT_ENSURE_REGISTERED (PacketProbe);
36 
37 TypeId
39 {
40  static TypeId tid = TypeId ("ns3::PacketProbe")
41  .SetParent<Probe> ()
42  .SetGroupName("Network")
43  .AddConstructor<PacketProbe> ()
44  .AddTraceSource ( "Output",
45  "The packet that serve as the output for this probe",
47  "ns3::Packet::TracedCallback")
48  .AddTraceSource ( "OutputBytes",
49  "The number of bytes in the packet",
51  "ns3::Packet::SizeTracedCallback")
52  ;
53  return tid;
54 }
55 
57 {
58  NS_LOG_FUNCTION (this);
59  m_packet = 0;
60 }
61 
63 {
64  NS_LOG_FUNCTION (this);
65 }
66 
67 void
69 {
70  NS_LOG_FUNCTION (this << packet);
71  m_packet = packet;
72  m_output (packet);
73 
74  uint32_t packetSizeNew = packet->GetSize ();
75  m_outputBytes (m_packetSizeOld, packetSizeNew);
76  m_packetSizeOld = packetSizeNew;
77 }
78 
79 void
81 {
82  NS_LOG_FUNCTION (path << packet);
83  Ptr<PacketProbe> probe = Names::Find<PacketProbe> (path);
84  NS_ASSERT_MSG (probe, "Error: Can't find probe for path " << path);
85  probe->SetValue (packet);
86 }
87 
88 bool
89 PacketProbe::ConnectByObject (std::string traceSource, Ptr<Object> obj)
90 {
91  NS_LOG_FUNCTION (this << traceSource << obj);
92  NS_LOG_DEBUG ("Name of probe (if any) in names database: " << Names::FindPath (obj));
93  bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::PacketProbe::TraceSink, this));
94  return connected;
95 }
96 
97 void
98 PacketProbe::ConnectByPath (std::string path)
99 {
100  NS_LOG_FUNCTION (this << path);
101  NS_LOG_DEBUG ("Name of probe to search for in config database: " << path);
103 }
104 
105 void
107 {
108  NS_LOG_FUNCTION (this << packet);
109  if (IsEnabled ())
110  {
111  m_packet = packet;
112  m_output (packet);
113 
114  uint32_t packetSizeNew = packet->GetSize ();
115  m_outputBytes (m_packetSizeOld, packetSizeNew);
116  m_packetSizeOld = packetSizeNew;
117  }
118 }
119 
120 } // namespace ns3
static TypeId GetTypeId()
Get the type ID.
Definition: packet-probe.cc:38
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
void TraceSink(Ptr< const Packet > packet)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet> ...
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
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:80
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:831
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
TracedCallback< uint32_t, uint32_t > m_outputBytes
Traced callback: size of previous packet receive, size of actual packet received. ...
Definition: packet-probe.h:104
NS_ASSERT_MSG(false,"Ipv4AddressGenerator::MaskToIndex(): Impossible")
TracedCallback< Ptr< const Packet > > m_output
Traced callback: packet received.
Definition: packet-probe.h:102
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1489
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:832
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
Definition: packet-probe.cc:89
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:293
Every class exported by the ns3 library is enclosed in the ns3 namespace.
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:826
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
Definition: packet-probe.cc:98
Ptr< const Packet > m_packet
The traced packet.
Definition: packet-probe.h:107
This class is designed to probe an underlying ns3 TraceSource exporting a packet. ...
Definition: packet-probe.h:47
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:270
virtual bool IsEnabled(void) const
Definition: probe.cc:64
virtual ~PacketProbe()
Definition: packet-probe.cc:62
void SetValue(Ptr< const Packet > packet)
Set a probe value.
Definition: packet-probe.cc:68
a unique identifier for an interface.
Definition: type-id.h:58
Base class for probes.
Definition: probe.h:39
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
uint32_t m_packetSizeOld
The size of the traced packet.
Definition: packet-probe.h:110