ndn-l3-rate-tracer.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef CCNX_RATE_L3_TRACER_H
#define CCNX_RATE_L3_TRACER_H

#include "ns3/ndnSIM/model/ndn-common.hpp"

#include "ndn-l3-tracer.hpp"

#include "ns3/nstime.h"
#include "ns3/event-id.h"
#include "ns3/node-container.h"

#include <tuple>
#include <map>
#include <list>

namespace ns3 {
namespace ndn {

class L3RateTracer : public L3Tracer {
public:
  static void
  InstallAll(const std::string& file, Time averagingPeriod = Seconds(0.5));

  static void
  Install(const NodeContainer& nodes, const std::string& file, Time averagingPeriod = Seconds(0.5));

  static void
  Install(Ptr<Node> node, const std::string& file, Time averagingPeriod = Seconds(0.5));

  static void
  Destroy();

  L3RateTracer(shared_ptr<std::ostream> os, Ptr<Node> node);

  L3RateTracer(shared_ptr<std::ostream> os, const std::string& node);

  virtual ~L3RateTracer();

  static Ptr<L3RateTracer>
  Install(Ptr<Node> node, shared_ptr<std::ostream> outputStream,
          Time averagingPeriod = Seconds(0.5));

  // from L3Tracer
  virtual void
  PrintHeader(std::ostream& os) const;

  virtual void
  Print(std::ostream& os) const;

protected:
  // from L3Tracer
  virtual void
  OutInterests(const Interest& interest, const Face& face);

  virtual void
  InInterests(const Interest& interest, const Face& face);

  virtual void
  OutData(const Data& data, const Face& face);

  virtual void
  InData(const Data& data, const Face& face);

  virtual void
  OutNack(const lp::Nack& nack, const Face& face);

  virtual void
  InNack(const lp::Nack& nack, const Face& face);

  virtual void
  SatisfiedInterests(const nfd::pit::Entry&, const Face&, const Data&);

  virtual void
  TimedOutInterests(const nfd::pit::Entry&);

private:
  void
  SetAveragingPeriod(const Time& period);

  void
  PeriodicPrinter();

  void
  Reset();

  void
  AddInfo(const Face& face);

private:
  shared_ptr<std::ostream> m_os;
  Time m_period;
  EventId m_printEvent;

  mutable std::map<nfd::FaceId, std::tuple<Stats, Stats, Stats, Stats>> m_stats;
  std::map<nfd::FaceId, std::string> m_faceInfos; // needed, because face may no longer exists at the time of stat printing
};

} // namespace ndn
} // namespace ns3

#endif // CCNX_RATE_L3_TRACER_H