blob: 7083cb66ea4febcc4f0fdb5eae1520c5d9590808 [file] [log] [blame]
Alexander Afanasyevc169a812014-05-20 20:37:29 -04001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Junxiao Shi5109dee2014-03-27 19:40:30 -07002/**
Alexander Afanasyev74633892015-02-08 18:08:46 -08003 * Copyright (c) 2013-2015 Regents of the University of California.
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07006 *
Alexander Afanasyevc169a812014-05-20 20:37:29 -04007 * 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.
Junxiao Shi5109dee2014-03-27 19:40:30 -070020 */
21
22#ifndef NDN_MANAGEMENT_NFD_FORWARDER_STATUS_HPP
23#define NDN_MANAGEMENT_NFD_FORWARDER_STATUS_HPP
24
Junxiao Shi65f1a712014-11-20 14:59:36 -070025#include "../encoding/block.hpp"
Alexander Afanasyev258ec2b2014-05-14 16:15:37 -070026#include "../util/time.hpp"
Junxiao Shi5109dee2014-03-27 19:40:30 -070027
28namespace ndn {
29namespace nfd {
30
Alexander Afanasyev4671bf72014-05-19 09:01:37 -040031/**
32 * \ingroup management
33 * \brief represents NFD Forwarder Status
34 * \sa http://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus
Junxiao Shi5109dee2014-03-27 19:40:30 -070035 */
36class ForwarderStatus
37{
38public:
Steve DiBenedetto54ce6682014-07-22 13:22:57 -060039 class Error : public tlv::Error
Junxiao Shi5109dee2014-03-27 19:40:30 -070040 {
41 public:
42 explicit
43 Error(const std::string& what)
Steve DiBenedetto54ce6682014-07-22 13:22:57 -060044 : tlv::Error(what)
Junxiao Shi5109dee2014-03-27 19:40:30 -070045 {
46 }
47 };
48
49 ForwarderStatus();
50
51 explicit
Junxiao Shi65f1a712014-11-20 14:59:36 -070052 ForwarderStatus(const Block& payload);
Junxiao Shi5109dee2014-03-27 19:40:30 -070053
54 /** \brief prepend ForwarderStatus as a Content block to the encoder
55 *
56 * The outermost Content element isn't part of ForwardStatus structure.
57 */
Alexander Afanasyev74633892015-02-08 18:08:46 -080058 template<encoding::Tag TAG>
Junxiao Shi5109dee2014-03-27 19:40:30 -070059 size_t
Alexander Afanasyev74633892015-02-08 18:08:46 -080060 wireEncode(EncodingImpl<TAG>& encoder) const;
Junxiao Shi5109dee2014-03-27 19:40:30 -070061
62 /** \brief encode ForwarderStatus as a Content block
63 *
64 * The outermost Content element isn't part of ForwardStatus structure.
65 */
66 const Block&
67 wireEncode() const;
68
69 /** \brief decode ForwarderStatus from a Content block
70 *
71 * The outermost Content element isn't part of ForwardStatus structure.
72 */
73 void
74 wireDecode(const Block& wire);
75
76public: // getters & setters
Hila Ben Abraham23f9e782014-12-02 02:21:34 -060077 const std::string&
Junxiao Shi5109dee2014-03-27 19:40:30 -070078 getNfdVersion() const
79 {
80 return m_nfdVersion;
81 }
82
83 ForwarderStatus&
Hila Ben Abraham23f9e782014-12-02 02:21:34 -060084 setNfdVersion(const std::string& nfdVersion);
Junxiao Shi5109dee2014-03-27 19:40:30 -070085
86 const time::system_clock::TimePoint&
87 getStartTimestamp() const
88 {
89 return m_startTimestamp;
90 }
91
92 ForwarderStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -070093 setStartTimestamp(const time::system_clock::TimePoint& startTimestamp);
Junxiao Shi5109dee2014-03-27 19:40:30 -070094
95 const time::system_clock::TimePoint&
96 getCurrentTimestamp() const
97 {
98 return m_currentTimestamp;
99 }
100
101 ForwarderStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -0700102 setCurrentTimestamp(const time::system_clock::TimePoint& currentTimestamp);
Junxiao Shi5109dee2014-03-27 19:40:30 -0700103
104 size_t
105 getNNameTreeEntries() const
106 {
107 return m_nNameTreeEntries;
108 }
109
110 ForwarderStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -0700111 setNNameTreeEntries(size_t nNameTreeEntries);
Junxiao Shi5109dee2014-03-27 19:40:30 -0700112
113 size_t
114 getNFibEntries() const
115 {
116 return m_nFibEntries;
117 }
118
119 ForwarderStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -0700120 setNFibEntries(size_t nFibEntries);
Junxiao Shi5109dee2014-03-27 19:40:30 -0700121
122 size_t
123 getNPitEntries() const
124 {
125 return m_nPitEntries;
126 }
127
128 ForwarderStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -0700129 setNPitEntries(size_t nPitEntries);
Junxiao Shi5109dee2014-03-27 19:40:30 -0700130
131 size_t
132 getNMeasurementsEntries() const
133 {
134 return m_nMeasurementsEntries;
135 }
136
137 ForwarderStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -0700138 setNMeasurementsEntries(size_t nMeasurementsEntries);
Junxiao Shi5109dee2014-03-27 19:40:30 -0700139
140 size_t
141 getNCsEntries() const
142 {
143 return m_nCsEntries;
144 }
145
146 ForwarderStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -0700147 setNCsEntries(size_t nCsEntries);
Junxiao Shi5109dee2014-03-27 19:40:30 -0700148
149 uint64_t
150 getNInInterests() const
151 {
152 return m_nInInterests;
153 }
154
155 ForwarderStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -0700156 setNInInterests(uint64_t nInInterests);
Junxiao Shi5109dee2014-03-27 19:40:30 -0700157
158 uint64_t
159 getNInDatas() const
160 {
161 return m_nInDatas;
162 }
163
164 ForwarderStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -0700165 setNInDatas(uint64_t nInDatas);
Junxiao Shi5109dee2014-03-27 19:40:30 -0700166
167 uint64_t
Eric Newberry95bd96a2015-09-04 23:34:22 -0700168 getNInNacks() const
169 {
170 return m_nInNacks;
171 }
172
173 ForwarderStatus&
174 setNInNacks(uint64_t nInNacks);
175
176 uint64_t
Junxiao Shi5109dee2014-03-27 19:40:30 -0700177 getNOutInterests() const
178 {
179 return m_nOutInterests;
180 }
181
182 ForwarderStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -0700183 setNOutInterests(uint64_t nOutInterests);
Junxiao Shi5109dee2014-03-27 19:40:30 -0700184
185 uint64_t
186 getNOutDatas() const
187 {
188 return m_nOutDatas;
189 }
190
191 ForwarderStatus&
Junxiao Shi65f1a712014-11-20 14:59:36 -0700192 setNOutDatas(uint64_t nOutDatas);
Junxiao Shi5109dee2014-03-27 19:40:30 -0700193
Eric Newberry95bd96a2015-09-04 23:34:22 -0700194 uint64_t
195 getNOutNacks() const
196 {
197 return m_nOutNacks;
198 }
199
200 ForwarderStatus&
201 setNOutNacks(uint64_t nOutNacks);
202
Junxiao Shi5109dee2014-03-27 19:40:30 -0700203private:
Hila Ben Abraham23f9e782014-12-02 02:21:34 -0600204 std::string m_nfdVersion;
Junxiao Shi5109dee2014-03-27 19:40:30 -0700205 time::system_clock::TimePoint m_startTimestamp;
206 time::system_clock::TimePoint m_currentTimestamp;
207 size_t m_nNameTreeEntries;
208 size_t m_nFibEntries;
209 size_t m_nPitEntries;
210 size_t m_nMeasurementsEntries;
211 size_t m_nCsEntries;
212 uint64_t m_nInInterests;
213 uint64_t m_nInDatas;
Eric Newberry95bd96a2015-09-04 23:34:22 -0700214 uint64_t m_nInNacks;
Junxiao Shi5109dee2014-03-27 19:40:30 -0700215 uint64_t m_nOutInterests;
216 uint64_t m_nOutDatas;
Eric Newberry95bd96a2015-09-04 23:34:22 -0700217 uint64_t m_nOutNacks;
Junxiao Shi5109dee2014-03-27 19:40:30 -0700218
219 mutable Block m_wire;
220};
221
Junxiao Shi5109dee2014-03-27 19:40:30 -0700222} // namespace nfd
223} // namespace ndn
224
225#endif // NDN_MANAGEMENT_NFD_FORWARDER_STATUS_HPP