NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
in-memory-storage-entry.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_ENTRY_HPP
23 #define NDN_IMS_IN_MEMORY_STORAGE_ENTRY_HPP
24 
25 #include "../data.hpp"
26 #include "../interest.hpp"
27 #include "../util/scheduler-scoped-event-id.hpp"
28 
29 namespace ndn {
30 
33 class InMemoryStorageEntry : noncopyable
34 {
35 public:
39 
42  void
43  release();
44 
47  const Name&
48  getName() const
49  {
50  return m_dataPacket->getName();
51  }
52 
56  const Name&
57  getFullName() const
58  {
59  return m_dataPacket->getFullName();
60  }
61 
64  const Data&
65  getData() const
66  {
67  return *m_dataPacket;
68  }
69 
74  void
75  setData(const Data& data);
76 
79  void
80  setMarkStaleEventId(unique_ptr<util::scheduler::ScopedEventId> eventId);
81 
84  void
85  markStale();
86 
89  bool
91  {
92  return m_isFresh;
93  }
94 
95 private:
96  shared_ptr<const Data> m_dataPacket;
97 
98  bool m_isFresh;
99  unique_ptr<util::scheduler::ScopedEventId> m_markStaleEventId;
100 };
101 
102 } // namespace ndn
103 
104 #endif // NDN_IMS_IN_MEMORY_STORAGE_ENTRY_HPP
Copyright (c) 2011-2015 Regents of the University of California.
void markStale()
Disable the data from satisfying interest with MustBeFresh.
const Name & getFullName() const
Returns the full name (including implicit digest) of the Data packet stored in the in-memory storage ...
void setData(const Data &data)
Changes the content of in-memory storage entry.
void setMarkStaleEventId(unique_ptr< util::scheduler::ScopedEventId > eventId)
Set eventId for the markStale event.
bool isFresh()
Check if the data can satisfy an interest with MustBeFresh.
Represents an absolute name.
Definition: name.hpp:42
Represents an in-memory storage entry.
const Data & getData() const
Returns the Data packet stored in the in-memory storage entry.
const Name & getName() const
Returns the name of the Data packet stored in the in-memory storage entry.
Represents a Data packet.
Definition: data.hpp:35
void release()
Releases reference counts on shared objects.