NS-3 based Named Data Networking (NDN) simulator
ndnSIM: NDN, CCN, CCNx, content centric networks 		API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
l2-rate-tracer.h
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
2 /*
3  * Copyright (c) 2013 University of California, Los Angeles
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  * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
19  */
20 
21 #ifndef L2_RATE_TRACER_H
22 #define L2_RATE_TRACER_H
23 
24 #include "l2-tracer.h"
25 
26 #include "ns3/nstime.h"
27 #include "ns3/event-id.h"
28 
29 #include <boost/tuple/tuple.hpp>
30 #include <boost/shared_ptr.hpp>
31 #include <map>
32 
33 namespace ns3 {
34 
41 class L2RateTracer : public L2Tracer
42 {
43 public:
47  L2RateTracer (boost::shared_ptr<std::ostream> os, Ptr<Node> node);
48  virtual ~L2RateTracer ();
49 
61  static void
62  InstallAll (const std::string &file, Time averagingPeriod = Seconds (0.5));
63 
70  static void
71  Destroy ();
72 
73  void
74  SetAveragingPeriod (const Time &period);
75 
76  virtual void
77  PrintHeader (std::ostream &os) const;
78 
79  virtual void
80  Print (std::ostream &os) const;
81 
82  virtual void
83  Drop (Ptr<const Packet>);
84 
85 private:
86  void
87  PeriodicPrinter ();
88 
89  void
90  Reset ();
91 
92 private:
93  boost::shared_ptr<std::ostream> m_os;
94  Time m_period;
95  EventId m_printEvent;
96 
97  mutable boost::tuple<Stats, Stats, Stats, Stats> m_stats;
98 };
99 
100 } // namespace ns3
101 
102 #endif // L2_RATE_TRACER_H
ns3::L2Tracer
Link-layer tracer.
Definition: l2-tracer.h:38
ns3::L2RateTracer::L2RateTracer
L2RateTracer(boost::shared_ptr< std::ostream > os, Ptr< Node > node)
Network layer tracer constructor.
Definition: l2-rate-tracer.cc:100
ns3::L2RateTracer::InstallAll
static void InstallAll(const std::string &file, Time averagingPeriod=Seconds(0.5))
Helper method to install tracers on all simulation nodes.
Definition: l2-rate-tracer.cc:56
ns3::L2RateTracer::Destroy
static void Destroy()
Explicit request to remove all statically created tracers.
Definition: l2-rate-tracer.cc:50
ns3::L2RateTracer
Tracer to collect link-layer rate information about links.
Definition: l2-rate-tracer.h:41