A Discrete-Event Network Simulator
API
application-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/application-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 ("ApplicationPacketProbe");
34 
35 NS_OBJECT_ENSURE_REGISTERED (ApplicationPacketProbe);
36 
37 TypeId
39 {
40  static TypeId tid = TypeId ("ns3::ApplicationPacketProbe")
41  .SetParent<Probe> ()
42  .SetGroupName("Applications")
43  .AddConstructor<ApplicationPacketProbe> ()
44  .AddTraceSource ( "Output",
45  "The packet plus its socket address that serve "
46  "as the output for this probe",
48  "ns3::Packet::AddressTracedCallback")
49  .AddTraceSource ( "OutputBytes",
50  "The number of bytes in the packet",
52  "ns3::Packet::SizeTracedCallback")
53  ;
54  return tid;
55 }
56 
58 {
59  NS_LOG_FUNCTION (this);
60  m_packet = 0;
61 }
62 
64 {
65  NS_LOG_FUNCTION (this);
66 }
67 
68 void
70 {
71  NS_LOG_FUNCTION (this << packet << address);
72  m_packet = packet;
74  m_output (packet, address);
75 
76  uint32_t packetSizeNew = packet->GetSize ();
77  m_outputBytes (m_packetSizeOld, packetSizeNew);
78  m_packetSizeOld = packetSizeNew;
79 }
80 
81 void
83 {
84  NS_LOG_FUNCTION (path << packet << address);
85  Ptr<ApplicationPacketProbe> probe = Names::Find<ApplicationPacketProbe> (path);
86  NS_ASSERT_MSG (probe, "Error: Can't find probe for path " << path);
87  probe->SetValue (packet, address);
88 }
89 
90 bool
92 {
93  NS_LOG_FUNCTION (this << traceSource << obj);
94  NS_LOG_DEBUG ("Name of probe (if any) in names database: " << Names::FindPath (obj));
95  bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::ApplicationPacketProbe::TraceSink, this));
96  return connected;
97 }
98 
99 void
101 {
102  NS_LOG_FUNCTION (this << path);
103  NS_LOG_DEBUG ("Name of probe to search for in config database: " << path);
105 }
106 
107 void
109 {
110  NS_LOG_FUNCTION (this << packet << address);
111  if (IsEnabled ())
112  {
113  m_packet = packet;
114  m_address = address;
115  m_output (packet, address);
116 
117  uint32_t packetSizeNew = packet->GetSize ();
118  m_outputBytes (m_packetSizeOld, packetSizeNew);
119  m_packetSizeOld = packetSizeNew;
120  }
121 }
122 
123 } // namespace ns3
void TraceSink(Ptr< const Packet > packet, const Address &address)
Method to connect to an underlying ns3::TraceSource with arguments of type Ptr<const Packet> and cons...
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
static void SetValueByPath(std::string path, Ptr< const Packet > packet, const Address &address)
Set a probe value by its name in the Config system.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
Definition: packet.h:831
a polymophic address class
Definition: address.h:90
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
static TypeId GetTypeId()
Get the type ID.
NS_ASSERT_MSG(false,"Ipv4AddressGenerator::MaskToIndex(): Impossible")
uint32_t m_packetSizeOld
The size of the traced packet.
TracedCallback< Ptr< const Packet >, const Address & > m_output
Output trace, packet and source address.
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
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.
address
Definition: first.py:37
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
Address m_address
The socket address for the traced packet.
void SetValue(Ptr< const Packet > packet, const Address &address)
Set a probe value.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:270
TracedCallback< uint32_t, uint32_t > m_outputBytes
Output trace, previous packet size and current packet size.
virtual bool IsEnabled(void) const
Definition: probe.cc:64
a unique identifier for an interface.
Definition: type-id.h:58
Probe to translate from a TraceSource to two more easily parsed TraceSources.
Base class for probes.
Definition: probe.h:39
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
Ptr< const Packet > m_packet
The traced packet.