in-memory-storage-fifo.hpp

Go to the documentation of this file.

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

#include "in-memory-storage.hpp"

#include <boost/multi_index_container.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/multi_index/hashed_index.hpp>

namespace ndn {
namespace util {

class InMemoryStorageFifo : public InMemoryStorage
{
public:
  explicit
  InMemoryStorageFifo(size_t limit = 10);

  virtual
  ~InMemoryStorageFifo();

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PROTECTED:
  virtual bool
  evictItem();

  virtual void
  afterInsert(InMemoryStorageEntry* entry);

  virtual void
  beforeErase(InMemoryStorageEntry* entry);

private:
  //multi_index_container to implement FIFO
  class byArrival;
  class byEntity;

  typedef boost::multi_index_container<
    InMemoryStorageEntry*,
    boost::multi_index::indexed_by<

      // by Entry itself
      boost::multi_index::hashed_unique<
        boost::multi_index::tag<byEntity>,
        boost::multi_index::identity<InMemoryStorageEntry*>
      >,

      // by arrival (FIFO)
      boost::multi_index::sequenced<
        boost::multi_index::tag<byArrival>
      >

    >
  > CleanupIndex;

  CleanupIndex m_cleanupIndex;
};

} // namespace util
} // namespace ndn

#endif // NDN_UTIL_IN_MEMORY_STORAGE_FIFO_HPP