blob: fc83fe51e911864d74c6696a71bf3d53889aaea7 [file] [log] [blame]
Jiewen Tan99135962014-09-20 02:18:53 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * Copyright (c) 2013-2014 Regents of the University of California.
4 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6 *
7 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License as published by the Free Software
9 * Foundation, either version 3 of the License, or (at your option) any later version.
10 *
11 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License and GNU Lesser
16 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17 * <http://www.gnu.org/licenses/>.
18 *
19 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20 */
21
22#ifndef NDN_UTIL_IN_MEMORY_STORAGE_FIFO_HPP
23#define NDN_UTIL_IN_MEMORY_STORAGE_FIFO_HPP
24
25#include "in-memory-storage.hpp"
26
27#include <boost/multi_index_container.hpp>
28#include <boost/multi_index/sequenced_index.hpp>
29#include <boost/multi_index/hashed_index.hpp>
30
31namespace ndn {
32namespace util {
33
34/** @brief Provides in-memory storage employing FIFO replacement policy, which is first in first
35 * out.
36 */
37class InMemoryStorageFifo : public InMemoryStorage
38{
39public:
40 explicit
41 InMemoryStorageFifo(size_t limit = 10);
42
43 virtual
44 ~InMemoryStorageFifo();
45
Junxiao Shi99848502014-10-13 19:22:22 -070046NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PROTECTED:
Jiewen Tan99135962014-09-20 02:18:53 -070047 /** @brief Removes one Data packet from in-memory storage based on FIFO
48 * @return{ whether the Data was removed }
49 */
50 virtual bool
51 evictItem();
52
53 /** @brief Update the entry after a entry is successfully inserted, add it to the cleanupIndex
54 */
55 virtual void
56 afterInsert(InMemoryStorageEntry* entry);
57
58 /** @brief Update the entry or other data structures before a entry is successfully erased,
59 * erase it from the cleanupIndex
60 */
61 virtual void
62 beforeErase(InMemoryStorageEntry* entry);
63
64private:
65 //multi_index_container to implement FIFO
66 class byArrival;
67 class byEntity;
68
69 typedef boost::multi_index_container<
70 InMemoryStorageEntry*,
71 boost::multi_index::indexed_by<
72
73 // by Entry itself
74 boost::multi_index::hashed_unique<
75 boost::multi_index::tag<byEntity>,
76 boost::multi_index::identity<InMemoryStorageEntry*>
77 >,
78
79 // by arrival (FIFO)
80 boost::multi_index::sequenced<
81 boost::multi_index::tag<byArrival>
82 >
83
84 >
85 > CleanupIndex;
86
87 CleanupIndex m_cleanupIndex;
88};
89
90} // namespace util
91} // namespace ndn
92
93#endif // NDN_UTIL_IN_MEMORY_STORAGE_FIFO_HPP