ndn-l3-protocol.hpp

Go to the documentation of this file.

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

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

#include <list>
#include <vector>

#include "ns3/ptr.h"
#include "ns3/net-device.h"
#include "ns3/nstime.h"
#include "ns3/traced-callback.h"

#include <boost/property_tree/ptree_fwd.hpp>

namespace nfd {
class Forwarder;
class FibManager;
class StrategyChoiceManager;
typedef boost::property_tree::ptree ConfigSection;
namespace pit {
class Entry;
} // namespace pit
namespace cs {
class Policy;
} // namespace cs
namespace rib {
class Service;
}
} // namespace nfd

namespace ns3 {

class Packet;
class Node;
class Header;

namespace ndn {

class L3Protocol : boost::noncopyable, public Object {
public:
  static TypeId
  GetTypeId();

  static const uint16_t ETHERNET_FRAME_TYPE; 
  static const uint16_t IP_STACK_PORT;       
  // static const uint16_t IP_PROTOCOL_TYPE;    ///< \brief IP protocol type of NDN

  L3Protocol();

  virtual ~L3Protocol();

  shared_ptr<nfd::Forwarder>
  getForwarder();

  shared_ptr<nfd::FibManager>
  getFibManager();

  nfd::StrategyChoiceManager&
  getStrategyChoiceManager();

  ::nfd::rib::Service&
  getRibService();

  nfd::FaceId
  addFace(shared_ptr<Face> face);

  shared_ptr<Face>
  getFaceById(nfd::FaceId face) const;

  // /**
  //  * \brief Remove face from ndn stack (remove callbacks)
  //  */
  // virtual void
  // removeFace(shared_ptr<Face> face);

  shared_ptr<Face>
  getFaceByNetDevice(Ptr<NetDevice> netDevice) const;

  nfd::ConfigSection&
  getConfig();

  void
  injectInterest(const Interest& interest);

  typedef std::function<std::unique_ptr<nfd::cs::Policy>()> PolicyCreationCallback;

  void
  setCsReplacementPolicy(const PolicyCreationCallback& policy);

public: // Workaround for python bindings
  static Ptr<L3Protocol>
  getL3Protocol(Ptr<Object> node);

public:
  typedef void (*InterestTraceCallback)(const Interest&, const Face&);
  typedef void (*DataTraceCallback)(const Data&, const Face&);

  typedef void (*SatisfiedInterestsCallback)(const nfd::pit::Entry& pitEntry, const Face& inFace, const Data& data);
  typedef void (*TimedOutInterestsCallback)(const nfd::pit::Entry& pitEntry);

protected:
  virtual void
  DoDispose(void); 

  virtual void
  NotifyNewAggregate();

private:
  void
  initialize();

  void
  initializeManagement();

  void
  initializeRibManager();

private:
  class Impl;
  std::unique_ptr<Impl> m_impl;

  // These objects are aggregated, but for optimization, get them here
  Ptr<Node> m_node; 

  TracedCallback<const Interest&, const Face&>
    m_inInterests; 
  TracedCallback<const Interest&, const Face&>
    m_outInterests; 

  TracedCallback<const Data&, const Face&> m_outData; 
  TracedCallback<const Data&, const Face&> m_inData;  

  TracedCallback<const lp::Nack&, const Face&> m_outNack; 
  TracedCallback<const lp::Nack&, const Face&> m_inNack;  

  TracedCallback<const nfd::pit::Entry&, const Face&/*in face*/, const Data&> m_satisfiedInterests;
  TracedCallback<const nfd::pit::Entry&> m_timedOutInterests;
};

} // namespace ndn
} // namespace ns3

#endif /* NDN_L3_PROTOCOL_H */