NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
in-memory-storage-lru.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2018 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_IMS_IN_MEMORY_STORAGE_LRU_HPP
23 #define NDN_IMS_IN_MEMORY_STORAGE_LRU_HPP
24 
26 
27 #include <boost/multi_index_container.hpp>
28 #include <boost/multi_index/hashed_index.hpp>
29 #include <boost/multi_index/identity.hpp>
30 #include <boost/multi_index/member.hpp>
31 #include <boost/multi_index/sequenced_index.hpp>
32 
33 namespace ndn {
34 
38 {
39 public:
40  explicit
41  InMemoryStorageLru(size_t limit = 16);
42 
43  InMemoryStorageLru(DummyIoService& ioService, size_t limit = 16);
44 
50  bool
51  evictItem() override;
52 
56  void
57  afterAccess(InMemoryStorageEntry* entry) override;
58 
61  void
62  afterInsert(InMemoryStorageEntry* entry) override;
63 
67  void
68  beforeErase(InMemoryStorageEntry* entry) override;
69 
70 private:
71  // multi_index_container to implement LRU
72  class byUsedTime;
73  class byEntity;
74 
75  typedef boost::multi_index_container<
77  boost::multi_index::indexed_by<
78 
79  // by Entry itself
80  boost::multi_index::hashed_unique<
81  boost::multi_index::tag<byEntity>,
82  boost::multi_index::identity<InMemoryStorageEntry*>
83  >,
84 
85  // by last used time (LRU)
86  boost::multi_index::sequenced<
87  boost::multi_index::tag<byUsedTime>
88  >
89 
90  >
91  > CleanupIndex;
92 
93  CleanupIndex m_cleanupIndex;
94 };
95 
96 } // namespace ndn
97 
98 #endif // NDN_IMS_IN_MEMORY_STORAGE_LRU_HPP
Copyright (c) 2011-2015 Regents of the University of California.
void afterInsert(InMemoryStorageEntry *entry) override
Update the entry after a entry is successfully inserted, add it to the cleanupIndex.
Represents in-memory storage.
virtual bool evictItem()=0
Removes one Data packet from in-memory storage based on derived class implemented replacement policy.
void afterAccess(InMemoryStorageEntry *entry) override
Update the entry when the entry is returned by the find() function, update the last used time accordi...
void beforeErase(InMemoryStorageEntry *entry) override
Update the entry or other data structures before a entry is successfully erased, erase it from the cl...
#define NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PROTECTED
Definition: common.hpp:42
Provides in-memory storage employing Least Recently Used (LRU) replacement policy.
Represents an in-memory storage entry.