NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
cs-info.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2021 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_CXX_MGMT_NFD_CS_INFO_HPP
23 #define NDN_CXX_MGMT_NFD_CS_INFO_HPP
24 
27 
28 #include <bitset>
29 
30 namespace ndn {
31 namespace nfd {
32 
37 class CsInfo
38 {
39 public:
40  class Error : public tlv::Error
41  {
42  public:
43  using tlv::Error::Error;
44  };
45 
46  CsInfo();
47 
48  explicit
49  CsInfo(const Block& block);
50 
51  template<encoding::Tag TAG>
52  size_t
53  wireEncode(EncodingImpl<TAG>& encoder) const;
54 
55  const Block&
56  wireEncode() const;
57 
58  void
59  wireDecode(const Block& wire);
60 
63  uint64_t
64  getCapacity() const
65  {
66  return m_capacity;
67  }
68 
69  CsInfo&
70  setCapacity(uint64_t capacity);
71 
74  bool
76  {
77  return m_flags.test(BIT_CS_ENABLE_ADMIT);
78  }
79 
80  CsInfo&
81  setEnableAdmit(bool enableAdmit);
82 
85  bool
87  {
88  return m_flags.test(BIT_CS_ENABLE_SERVE);
89  }
90 
91  CsInfo&
92  setEnableServe(bool enableServe);
93 
96  uint64_t
97  getNEntries() const
98  {
99  return m_nEntries;
100  }
101 
102  CsInfo&
103  setNEntries(uint64_t nEntries);
104 
107  uint64_t
108  getNHits() const
109  {
110  return m_nHits;
111  }
112 
113  CsInfo&
114  setNHits(uint64_t nHits);
115 
118  uint64_t
119  getNMisses() const
120  {
121  return m_nMisses;
122  }
123 
124  CsInfo&
125  setNMisses(uint64_t nMisses);
126 
127 private:
128  using FlagsBitSet = std::bitset<2>;
129 
130  uint64_t m_capacity;
131  FlagsBitSet m_flags;
132  uint64_t m_nEntries;
133  uint64_t m_nHits;
134  uint64_t m_nMisses;
135 
136  mutable Block m_wire;
137 };
138 
140 
141 bool
142 operator==(const CsInfo& a, const CsInfo& b);
143 
144 inline bool
145 operator!=(const CsInfo& a, const CsInfo& b)
146 {
147  return !(a == b);
148 }
149 
150 std::ostream&
151 operator<<(std::ostream& os, const CsInfo& csi);
152 
153 } // namespace nfd
154 } // namespace ndn
155 
156 #endif // NDN_CXX_MGMT_NFD_CS_INFO_HPP
CsInfo & setNHits(uint64_t nHits)
Definition: cs-info.cpp:165
uint64_t getNMisses() const
get number of CS lookup misses since NFD starts
Definition: cs-info.hpp:119
Copyright (c) 2011-2015 Regents of the University of California.
bool operator!=(const ChannelStatus &a, const ChannelStatus &b)
uint64_t getCapacity() const
get CS capacity (in number of packets)
Definition: cs-info.hpp:64
const Block & wireEncode() const
Definition: cs-info.cpp:66
bool getEnableAdmit() const
get CS_ENABLE_ADMIT flag
Definition: cs-info.hpp:75
bool getEnableServe() const
get CS_ENABLE_SERVE flag
Definition: cs-info.hpp:86
Represents a TLV element of the NDN packet format.
Definition: block.hpp:44
CsInfo & setNEntries(uint64_t nEntries)
Definition: cs-info.cpp:157
CsInfo & setEnableAdmit(bool enableAdmit)
Definition: cs-info.cpp:141
uint64_t getNHits() const
get number of CS lookup hits since NFD starts
Definition: cs-info.hpp:108
void wireDecode(const Block &wire)
Definition: cs-info.cpp:82
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
CsInfo & setEnableServe(bool enableServe)
Definition: cs-info.cpp:149
bool operator==(const ChannelStatus &a, const ChannelStatus &b)
enables the CS to satisfy Interests using cached Data
enables the CS to admit new Data
std::ostream & operator<<(std::ostream &os, FaceScope faceScope)
represents the CS Information dataset
Definition: cs-info.hpp:37
CsInfo & setCapacity(uint64_t capacity)
Definition: cs-info.cpp:133
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ChannelStatus)
CsInfo & setNMisses(uint64_t nMisses)
Definition: cs-info.cpp:173
Error(const char *expectedType, uint32_t actualType)
Definition: tlv.cpp:27
represents an error in TLV encoding or decoding
Definition: tlv.hpp:52
uint64_t getNEntries() const
get number of stored CS entries
Definition: cs-info.hpp:97