NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
in-memory-storage-fifo.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2017 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_FIFO_HPP
23 #define NDN_IMS_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/hashed_index.hpp>
29 #include <boost/multi_index/sequenced_index.hpp>
30 
31 namespace ndn {
32 
36 {
37 public:
38  explicit
39  InMemoryStorageFifo(size_t limit = 10);
40 
41  explicit
42  InMemoryStorageFifo(boost::asio::io_service& ioService, size_t limit = 10);
43 
48  bool
49  evictItem() override;
50 
53  void
54  afterInsert(InMemoryStorageEntry* entry) override;
55 
59  void
60  beforeErase(InMemoryStorageEntry* entry) override;
61 
62 private:
63  // multi_index_container to implement FIFO
64  class byArrival;
65  class byEntity;
66 
67  typedef boost::multi_index_container<
69  boost::multi_index::indexed_by<
70 
71  // by Entry itself
72  boost::multi_index::hashed_unique<
73  boost::multi_index::tag<byEntity>,
74  boost::multi_index::identity<InMemoryStorageEntry*>
75  >,
76 
77  // by arrival (FIFO)
78  boost::multi_index::sequenced<
79  boost::multi_index::tag<byArrival>
80  >
81 
82  >
83  > CleanupIndex;
84 
85  CleanupIndex m_cleanupIndex;
86 };
87 
88 } // namespace ndn
89 
90 #endif // NDN_IMS_IN_MEMORY_STORAGE_FIFO_HPP
Copyright (c) 2011-2015 Regents of the University of California.
void beforeErase(InMemoryStorageEntry *entry) override
Update the entry or other data structures before a entry is successfully erased, erase it from the cl...
Provides in-memory storage employing First-In-First-Out (FIFO) replacement policy.
Represents in-memory storage.
virtual bool evictItem()=0
Removes one Data packet from in-memory storage based on derived class implemented replacement policy...
Represents an in-memory storage entry.
#define NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PROTECTED
Definition: common.hpp:42
void afterInsert(InMemoryStorageEntry *entry) override
Update the entry after a entry is successfully inserted, add it to the cleanupIndex.