ndn-cs-tracer.hpp

Go to the documentation of this file.

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

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

#include "ns3/ptr.h"
#include "ns3/simple-ref-count.h"
#include <ns3/nstime.h>
#include <ns3/event-id.h>
#include <ns3/node-container.h>

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

namespace ns3 {

class Node;
class Packet;

namespace ndn {

namespace cs {

struct Stats {
  inline void
  Reset()
  {
    m_cacheHits = 0;
    m_cacheMisses = 0;
  }
  double m_cacheHits;
  double m_cacheMisses;
};
}

class CsTracer : public SimpleRefCount<CsTracer> {
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 Ptr<CsTracer>
  Install(Ptr<Node> node, shared_ptr<std::ostream> outputStream,
          Time averagingPeriod = Seconds(0.5));

  static void
  Destroy();

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

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

  ~CsTracer();

  void
  PrintHeader(std::ostream& os) const;

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

private:
  void
  Connect();

  void
  CacheHits(shared_ptr<const Interest>, shared_ptr<const Data>);

  void
  CacheMisses(shared_ptr<const Interest>);

private:
  void
  SetAveragingPeriod(const Time& period);

  void
  Reset();

  void
  PeriodicPrinter();

private:
  std::string m_node;
  Ptr<Node> m_nodePtr;

  shared_ptr<std::ostream> m_os;

  Time m_period;
  EventId m_printEvent;
  cs::Stats m_stats;
};

inline std::ostream&
operator<<(std::ostream& os, const CsTracer& tracer)
{
  os << "# ";
  tracer.PrintHeader(os);
  os << "\n";
  tracer.Print(os);
  return os;
}

} // namespace ndn
} // namespace ns3

#endif // CCNX_CS_TRACER_H