cs-policy-lru.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2019, Regents of the University of California,
4  * Arizona Board of Regents,
5  * Colorado State University,
6  * University Pierre & Marie Curie, Sorbonne University,
7  * Washington University in St. Louis,
8  * Beijing Institute of Technology,
9  * The University of Memphis.
10  *
11  * This file is part of NFD (Named Data Networking Forwarding Daemon).
12  * See AUTHORS.md for complete list of NFD authors and contributors.
13  *
14  * NFD is free software: you can redistribute it and/or modify it under the terms
15  * of the GNU General Public License as published by the Free Software Foundation,
16  * either version 3 of the License, or (at your option) any later version.
17  *
18  * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along with
23  * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
26 #ifndef NFD_DAEMON_TABLE_CS_POLICY_LRU_HPP
27 #define NFD_DAEMON_TABLE_CS_POLICY_LRU_HPP
28 
29 #include "cs-policy.hpp"
30 
31 #include <boost/multi_index_container.hpp>
32 #include <boost/multi_index/sequenced_index.hpp>
33 #include <boost/multi_index/ordered_index.hpp>
34 
35 namespace nfd {
36 namespace cs {
37 namespace lru {
38 
39 using Queue = boost::multi_index_container<
41  boost::multi_index::indexed_by<
42  boost::multi_index::sequenced<>,
43  boost::multi_index::ordered_unique<boost::multi_index::identity<Policy::EntryRef>>
44  >
45  >;
46 
49 class LruPolicy : public Policy
50 {
51 public:
52  LruPolicy();
53 
54 public:
55  static const std::string POLICY_NAME;
56 
57 private:
58  void
59  doAfterInsert(EntryRef i) override;
60 
61  void
62  doAfterRefresh(EntryRef i) override;
63 
64  void
65  doBeforeErase(EntryRef i) override;
66 
67  void
68  doBeforeUse(EntryRef i) override;
69 
70  void
71  evictEntries() override;
72 
73 private:
76  void
77  insertToQueue(EntryRef i, bool isNewEntry);
78 
79 private:
80  Queue m_queue;
81 };
82 
83 } // namespace lru
84 
85 using lru::LruPolicy;
86 
87 } // namespace cs
88 } // namespace nfd
89 
90 #endif // NFD_DAEMON_TABLE_CS_POLICY_LRU_HPP
boost::multi_index_container< Policy::EntryRef, boost::multi_index::indexed_by< boost::multi_index::sequenced<>, boost::multi_index::ordered_unique< boost::multi_index::identity< Policy::EntryRef >> > > Queue
Least-Recently-Used (LRU) replacement policy.
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
static const std::string POLICY_NAME
represents a CS replacement policy
Definition: cs-policy.hpp:38
Table::const_iterator EntryRef
a reference to an CS entry
Definition: cs-policy.hpp:111