ndn-pit.h

/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil -*- */
/*
 * Copyright (c) 2011 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>
 */

#ifndef _NDN_PIT_H_
#define _NDN_PIT_H_

#include "ns3/object.h"
#include "ns3/nstime.h"
#include "ns3/event-id.h"

#include "ndn-pit-entry.h"

namespace ns3 {
namespace ndn {

namespace pit {
}

class L3Protocol;
class Face;
class Data;
class Interest;

typedef Interest InterestHeader;
typedef Data DataHeader;


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

  Pit ();

  virtual ~Pit ();

  virtual Ptr<pit::Entry>
  Lookup (const Data &header) = 0;

  virtual Ptr<pit::Entry>
  Lookup (const Interest &header) = 0;

  virtual Ptr<pit::Entry>
  Find (const Name &prefix) = 0;

  virtual Ptr<pit::Entry>
  Create (Ptr<const Interest> header) = 0;

  virtual void
  MarkErased (Ptr<pit::Entry> entry) = 0;

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

  virtual uint32_t
  GetSize () const = 0;

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

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

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


  static inline Ptr<Pit>
  GetPit (Ptr<Object> node);

  inline const Time&
  GetMaxPitEntryLifetime () const;

  inline void
  SetMaxPitEntryLifetime (const Time &maxLifetime);

protected:
  // configuration variables. Check implementation of GetTypeId for more details
  Time m_PitEntryPruningTimout;

  Time m_maxPitEntryLifetime;
};


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

inline Ptr<Pit>
Pit::GetPit (Ptr<Object> node)
{
  return node->GetObject<Pit> ();
}

inline const Time&
Pit::GetMaxPitEntryLifetime () const
{
  return m_maxPitEntryLifetime;
}

inline void
Pit::SetMaxPitEntryLifetime (const Time &maxLifetime)
{
  m_maxPitEntryLifetime = maxLifetime;
}


} // namespace ndn
} // namespace ns3

#endif  /* NDN_PIT_H */