blob: 478739890133b8a98b8d6dfdef3f03ad163dd8e8 [file] [log] [blame]
Jiewen Tan99135962014-09-20 02:18:53 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Yingdi Yu404eafd2016-03-06 14:54:25 -08003 * Copyright (c) 2013-2016 Regents of the University of California.
Jiewen Tan99135962014-09-20 02:18:53 -07004 *
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_LRU_HPP
23#define NDN_UTIL_IN_MEMORY_STORAGE_LRU_HPP
24
25#include "in-memory-storage.hpp"
26
27#include <boost/multi_index/member.hpp>
28#include <boost/multi_index_container.hpp>
29#include <boost/multi_index/sequenced_index.hpp>
30#include <boost/multi_index/hashed_index.hpp>
31#include <boost/multi_index/identity.hpp>
32
33namespace ndn {
34namespace util {
35
36/** @brief Provides in-memory storage employing LRU replacement policy, of which the least
37 * recently used entry will be evict first.
38 */
39class InMemoryStorageLru : public InMemoryStorage
40{
41public:
42 explicit
43 InMemoryStorageLru(size_t limit = 10);
44
Yingdi Yu404eafd2016-03-06 14:54:25 -080045 InMemoryStorageLru(boost::asio::io_service& ioService, size_t limit = 10);
46
Junxiao Shi99848502014-10-13 19:22:22 -070047NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PROTECTED:
Jiewen Tan99135962014-09-20 02:18:53 -070048 /** @brief Removes one Data packet from in-memory storage based on LRU, i.e. evict the least
49 * recently accessed Data packet
50 * @return{ whether the Data was removed }
51 */
52 virtual bool
Davide Pesaventoaeeb3fc2016-08-14 03:40:02 +020053 evictItem() override;
Jiewen Tan99135962014-09-20 02:18:53 -070054
55 /** @brief Update the entry when the entry is returned by the find() function,
56 * update the last used time according to LRU
57 */
58 virtual void
Davide Pesaventoaeeb3fc2016-08-14 03:40:02 +020059 afterAccess(InMemoryStorageEntry* entry) override;
Jiewen Tan99135962014-09-20 02:18:53 -070060
61 /** @brief Update the entry after a entry is successfully inserted, add it to the cleanupIndex
62 */
63 virtual void
Davide Pesaventoaeeb3fc2016-08-14 03:40:02 +020064 afterInsert(InMemoryStorageEntry* entry) override;
Jiewen Tan99135962014-09-20 02:18:53 -070065
66 /** @brief Update the entry or other data structures before a entry is successfully erased,
67 * erase it from the cleanupIndex
68 */
69 virtual void
Davide Pesaventoaeeb3fc2016-08-14 03:40:02 +020070 beforeErase(InMemoryStorageEntry* entry) override;
Jiewen Tan99135962014-09-20 02:18:53 -070071
72private:
73 //multi_index_container to implement LRU
74 class byUsedTime;
75 class byEntity;
76
77 typedef boost::multi_index_container<
78 InMemoryStorageEntry*,
79 boost::multi_index::indexed_by<
80
81 // by Entry itself
82 boost::multi_index::hashed_unique<
83 boost::multi_index::tag<byEntity>,
84 boost::multi_index::identity<InMemoryStorageEntry*>
85 >,
86
87 // by last used time (LRU)
88 boost::multi_index::sequenced<
89 boost::multi_index::tag<byUsedTime>
90 >
91
92 >
93 > CleanupIndex;
94
95 CleanupIndex m_cleanupIndex;
96};
97
98} // namespace util
99} // namespace ndn
100
101#endif // NDN_UTIL_IN_MEMORY_STORAGE_LRU_HPP