ndn-content-store.h

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2011,2012 University of California, Los Angeles
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
 *         Ilya Moiseenko <iliamo@cs.ucla.edu>
 */

#ifndef NDN_CONTENT_STORE_H
#define NDN_CONTENT_STORE_H

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

#include <boost/tuple/tuple.hpp>

namespace ns3 {

class Packet;

namespace ndn {

class Data;
class Interest;
class Name;
class ContentStore;

namespace cs {

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

  const Name&
  GetName () const;

  Ptr<const Data>
  GetData () const;

  Ptr<ContentStore>
  GetContentStore ();

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

} // namespace cs


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

  virtual
  ~ContentStore ();

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

  virtual bool
  Add (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 (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);

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

  TracedCallback<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

#endif // NDN_CONTENT_STORE_H