ndn-content-store.hpp

Go to the documentation of this file.

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

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

#include "ns3/object.h"
#include "ns3/ptr.h"
#include "ns3/traced-callback.h"

#include <tuple>

namespace ns3 {

class Packet;

namespace ndn {

class ContentStore;

namespace cs {

class Entry : public SimpleRefCount<Entry> {
public:
  Entry(Ptr<ContentStore> cs, shared_ptr<const Data> data);

  const Name&
  GetName() const;

  shared_ptr<const Data>
  GetData() const;

  Ptr<ContentStore>
  GetContentStore();

private:
  Ptr<ContentStore> m_cs;        
  shared_ptr<const Data> m_data; 
};

} // namespace cs

class ContentStore : public Object {
public:
  static TypeId
  GetTypeId();

  virtual ~ContentStore();

  virtual shared_ptr<Data>
  Lookup(shared_ptr<const Interest> interest) = 0;

  virtual bool
  Add(shared_ptr<const Data> data) = 0;

  // /*
  //  * \brief Add a new content to the content store.
  //  *
  //  * \param header Interest header for which an entry should be removed
  //  * @returns true if an existing entry was removed, false otherwise
  //  */
  // virtual bool
  // Remove (shared_ptr<Interest> header) = 0;

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

  virtual uint32_t
  GetSize() const = 0;

  virtual Ptr<cs::Entry>
  Begin() = 0;

  virtual Ptr<cs::Entry>
  End() = 0;

  virtual Ptr<cs::Entry> Next(Ptr<cs::Entry>) = 0;


  static inline Ptr<ContentStore>
  GetContentStore(Ptr<Object> node);

public:
  typedef void (*CacheHitsCallback)(shared_ptr<const Interest>, shared_ptr<const Data>);
  typedef void (*CacheMissesCallback)(shared_ptr<const Interest>);

protected:
  TracedCallback<shared_ptr<const Interest>,
                 shared_ptr<const Data>> m_cacheHitsTrace; 

  TracedCallback<shared_ptr<const Interest>> m_cacheMissesTrace; 
};

inline std::ostream&
operator<<(std::ostream& os, const ContentStore& cs)
{
  cs.Print(os);
  return os;
}

inline Ptr<ContentStore>
ContentStore::GetContentStore(Ptr<Object> node)
{
  return node->GetObject<ContentStore>();
}

} // namespace ndn
} // namespace ns3

#include <boost/functional/hash.hpp>
namespace boost {
inline std::size_t
hash_value(const ::ndn::name::Component component)
{
  return boost::hash_range(component.wireEncode().wire(),
                           component.wireEncode().wire() + component.wireEncode().size());
}
}

#endif // NDN_CONTENT_STORE_H