Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
Davide Pesavento | 88a0d81 | 2017-08-19 21:31:42 -0400 | [diff] [blame] | 2 | /* |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 3 | * Copyright (c) 2013-2018 Regents of the University of California. |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 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_MGMT_NFD_FORWARDER_STATUS_HPP |
| 23 | #define NDN_MGMT_NFD_FORWARDER_STATUS_HPP |
| 24 | |
| 25 | #include "../../encoding/block.hpp" |
| 26 | #include "../../util/time.hpp" |
| 27 | |
| 28 | namespace ndn { |
| 29 | namespace nfd { |
| 30 | |
| 31 | /** |
| 32 | * \ingroup management |
Davide Pesavento | 25e3d8c | 2017-02-08 22:17:46 -0500 | [diff] [blame] | 33 | * \brief represents NFD General Status dataset |
| 34 | * \sa https://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus#General-Status-Dataset |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 35 | */ |
| 36 | class ForwarderStatus |
| 37 | { |
| 38 | public: |
| 39 | class Error : public tlv::Error |
| 40 | { |
| 41 | public: |
| 42 | explicit |
| 43 | Error(const std::string& what) |
| 44 | : tlv::Error(what) |
| 45 | { |
| 46 | } |
| 47 | }; |
| 48 | |
| 49 | ForwarderStatus(); |
| 50 | |
| 51 | explicit |
| 52 | ForwarderStatus(const Block& payload); |
| 53 | |
| 54 | /** \brief prepend ForwarderStatus as a Content block to the encoder |
| 55 | * |
Davide Pesavento | 25e3d8c | 2017-02-08 22:17:46 -0500 | [diff] [blame] | 56 | * The outermost Content element isn't part of ForwarderStatus structure. |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 57 | */ |
| 58 | template<encoding::Tag TAG> |
| 59 | size_t |
| 60 | wireEncode(EncodingImpl<TAG>& encoder) const; |
| 61 | |
| 62 | /** \brief encode ForwarderStatus as a Content block |
| 63 | * |
Davide Pesavento | 25e3d8c | 2017-02-08 22:17:46 -0500 | [diff] [blame] | 64 | * The outermost Content element isn't part of ForwarderStatus structure. |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 65 | */ |
| 66 | const Block& |
| 67 | wireEncode() const; |
| 68 | |
| 69 | /** \brief decode ForwarderStatus from a Content block |
| 70 | * |
Davide Pesavento | 25e3d8c | 2017-02-08 22:17:46 -0500 | [diff] [blame] | 71 | * The outermost Content element isn't part of ForwarderStatus structure. |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 72 | */ |
| 73 | void |
| 74 | wireDecode(const Block& wire); |
| 75 | |
| 76 | public: // getters & setters |
| 77 | const std::string& |
| 78 | getNfdVersion() const |
| 79 | { |
| 80 | return m_nfdVersion; |
| 81 | } |
| 82 | |
| 83 | ForwarderStatus& |
| 84 | setNfdVersion(const std::string& nfdVersion); |
| 85 | |
| 86 | const time::system_clock::TimePoint& |
| 87 | getStartTimestamp() const |
| 88 | { |
| 89 | return m_startTimestamp; |
| 90 | } |
| 91 | |
| 92 | ForwarderStatus& |
| 93 | setStartTimestamp(const time::system_clock::TimePoint& startTimestamp); |
| 94 | |
| 95 | const time::system_clock::TimePoint& |
| 96 | getCurrentTimestamp() const |
| 97 | { |
| 98 | return m_currentTimestamp; |
| 99 | } |
| 100 | |
| 101 | ForwarderStatus& |
| 102 | setCurrentTimestamp(const time::system_clock::TimePoint& currentTimestamp); |
| 103 | |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 104 | uint64_t |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 105 | getNNameTreeEntries() const |
| 106 | { |
| 107 | return m_nNameTreeEntries; |
| 108 | } |
| 109 | |
| 110 | ForwarderStatus& |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 111 | setNNameTreeEntries(uint64_t nNameTreeEntries); |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 112 | |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 113 | uint64_t |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 114 | getNFibEntries() const |
| 115 | { |
| 116 | return m_nFibEntries; |
| 117 | } |
| 118 | |
| 119 | ForwarderStatus& |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 120 | setNFibEntries(uint64_t nFibEntries); |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 121 | |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 122 | uint64_t |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 123 | getNPitEntries() const |
| 124 | { |
| 125 | return m_nPitEntries; |
| 126 | } |
| 127 | |
| 128 | ForwarderStatus& |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 129 | setNPitEntries(uint64_t nPitEntries); |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 130 | |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 131 | uint64_t |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 132 | getNMeasurementsEntries() const |
| 133 | { |
| 134 | return m_nMeasurementsEntries; |
| 135 | } |
| 136 | |
| 137 | ForwarderStatus& |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 138 | setNMeasurementsEntries(uint64_t nMeasurementsEntries); |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 139 | |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 140 | uint64_t |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 141 | getNCsEntries() const |
| 142 | { |
| 143 | return m_nCsEntries; |
| 144 | } |
| 145 | |
| 146 | ForwarderStatus& |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 147 | setNCsEntries(uint64_t nCsEntries); |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 148 | |
| 149 | uint64_t |
| 150 | getNInInterests() const |
| 151 | { |
| 152 | return m_nInInterests; |
| 153 | } |
| 154 | |
| 155 | ForwarderStatus& |
| 156 | setNInInterests(uint64_t nInInterests); |
| 157 | |
| 158 | uint64_t |
Junxiao Shi | 9a53d78 | 2017-04-04 20:09:57 +0000 | [diff] [blame] | 159 | getNInData() const |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 160 | { |
Junxiao Shi | 9a53d78 | 2017-04-04 20:09:57 +0000 | [diff] [blame] | 161 | return m_nInData; |
| 162 | } |
| 163 | |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 164 | ForwarderStatus& |
Junxiao Shi | 9a53d78 | 2017-04-04 20:09:57 +0000 | [diff] [blame] | 165 | setNInData(uint64_t nInData); |
| 166 | |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 167 | uint64_t |
| 168 | getNInNacks() const |
| 169 | { |
| 170 | return m_nInNacks; |
| 171 | } |
| 172 | |
| 173 | ForwarderStatus& |
| 174 | setNInNacks(uint64_t nInNacks); |
| 175 | |
| 176 | uint64_t |
| 177 | getNOutInterests() const |
| 178 | { |
| 179 | return m_nOutInterests; |
| 180 | } |
| 181 | |
| 182 | ForwarderStatus& |
| 183 | setNOutInterests(uint64_t nOutInterests); |
| 184 | |
| 185 | uint64_t |
Junxiao Shi | 9a53d78 | 2017-04-04 20:09:57 +0000 | [diff] [blame] | 186 | getNOutData() const |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 187 | { |
Junxiao Shi | 9a53d78 | 2017-04-04 20:09:57 +0000 | [diff] [blame] | 188 | return m_nOutData; |
| 189 | } |
| 190 | |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 191 | ForwarderStatus& |
Junxiao Shi | 9a53d78 | 2017-04-04 20:09:57 +0000 | [diff] [blame] | 192 | setNOutData(uint64_t nOutData); |
| 193 | |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 194 | uint64_t |
| 195 | getNOutNacks() const |
| 196 | { |
| 197 | return m_nOutNacks; |
| 198 | } |
| 199 | |
| 200 | ForwarderStatus& |
| 201 | setNOutNacks(uint64_t nOutNacks); |
| 202 | |
| 203 | private: |
| 204 | std::string m_nfdVersion; |
| 205 | time::system_clock::TimePoint m_startTimestamp; |
| 206 | time::system_clock::TimePoint m_currentTimestamp; |
Junxiao Shi | 643b7f5 | 2018-07-18 08:05:01 -0600 | [diff] [blame^] | 207 | uint64_t m_nNameTreeEntries; |
| 208 | uint64_t m_nFibEntries; |
| 209 | uint64_t m_nPitEntries; |
| 210 | uint64_t m_nMeasurementsEntries; |
| 211 | uint64_t m_nCsEntries; |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 212 | uint64_t m_nInInterests; |
Junxiao Shi | 9a53d78 | 2017-04-04 20:09:57 +0000 | [diff] [blame] | 213 | uint64_t m_nInData; |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 214 | uint64_t m_nInNacks; |
| 215 | uint64_t m_nOutInterests; |
Junxiao Shi | 9a53d78 | 2017-04-04 20:09:57 +0000 | [diff] [blame] | 216 | uint64_t m_nOutData; |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 217 | uint64_t m_nOutNacks; |
| 218 | |
| 219 | mutable Block m_wire; |
| 220 | }; |
| 221 | |
Davide Pesavento | 88a0d81 | 2017-08-19 21:31:42 -0400 | [diff] [blame] | 222 | NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ForwarderStatus); |
| 223 | |
Davide Pesavento | 25e3d8c | 2017-02-08 22:17:46 -0500 | [diff] [blame] | 224 | bool |
| 225 | operator==(const ForwarderStatus& a, const ForwarderStatus& b); |
| 226 | |
| 227 | inline bool |
| 228 | operator!=(const ForwarderStatus& a, const ForwarderStatus& b) |
| 229 | { |
| 230 | return !(a == b); |
| 231 | } |
| 232 | |
| 233 | std::ostream& |
| 234 | operator<<(std::ostream& os, const ForwarderStatus& status); |
| 235 | |
Junxiao Shi | 7357ef2 | 2016-09-07 02:39:37 +0000 | [diff] [blame] | 236 | } // namespace nfd |
| 237 | } // namespace ndn |
| 238 | |
| 239 | #endif // NDN_MGMT_NFD_FORWARDER_STATUS_HPP |