blob: d34973af5f07886844992c8e00749d1370d6d89e [file] [log] [blame]
Junxiao Shi7357ef22016-09-07 02:39:37 +00001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Davide Pesavento7f20d6e2017-01-16 14:43:58 -05003 * Copyright (c) 2013-2017 Regents of the University of California.
Junxiao Shi7357ef22016-09-07 02:39:37 +00004 *
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_FACE_STATUS_HPP
23#define NDN_MGMT_NFD_FACE_STATUS_HPP
24
Davide Pesavento7f20d6e2017-01-16 14:43:58 -050025#include "face-traits.hpp"
Junxiao Shi7357ef22016-09-07 02:39:37 +000026#include "../../util/time.hpp"
27
28namespace ndn {
29namespace nfd {
30
31/**
32 * \ingroup management
Davide Pesavento4ec7a5a2017-02-07 23:13:39 -050033 * \brief represents an item in NFD Face dataset
34 * \sa https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Face-Dataset
Junxiao Shi7357ef22016-09-07 02:39:37 +000035 */
36class FaceStatus : public FaceTraits<FaceStatus>
37{
38public:
39 FaceStatus();
40
41 explicit
42 FaceStatus(const Block& block);
43
44 /** \brief prepend FaceStatus to the encoder
45 */
46 template<encoding::Tag TAG>
47 size_t
48 wireEncode(EncodingImpl<TAG>& encoder) const;
49
50 /** \brief encode FaceStatus
51 */
52 const Block&
53 wireEncode() const;
54
55 /** \brief decode FaceStatus
56 */
57 void
58 wireDecode(const Block& wire);
59
60public: // getters & setters
61 bool
62 hasExpirationPeriod() const
63 {
Davide Pesavento4ec7a5a2017-02-07 23:13:39 -050064 return !!m_expirationPeriod;
Junxiao Shi7357ef22016-09-07 02:39:37 +000065 }
66
Davide Pesavento4ec7a5a2017-02-07 23:13:39 -050067 time::milliseconds
Junxiao Shi7357ef22016-09-07 02:39:37 +000068 getExpirationPeriod() const
69 {
Davide Pesavento4ec7a5a2017-02-07 23:13:39 -050070 BOOST_ASSERT(hasExpirationPeriod());
71 return *m_expirationPeriod;
Junxiao Shi7357ef22016-09-07 02:39:37 +000072 }
73
74 FaceStatus&
Davide Pesavento4ec7a5a2017-02-07 23:13:39 -050075 setExpirationPeriod(time::milliseconds expirationPeriod);
Junxiao Shi7357ef22016-09-07 02:39:37 +000076
Davide Pesavento156c1ea2017-03-19 16:09:33 -040077 FaceStatus&
78 unsetExpirationPeriod();
79
Junxiao Shi7357ef22016-09-07 02:39:37 +000080 uint64_t
81 getNInInterests() const
82 {
83 return m_nInInterests;
84 }
85
86 FaceStatus&
87 setNInInterests(uint64_t nInInterests);
88
89 uint64_t
Junxiao Shi9a53d782017-04-04 20:09:57 +000090 getNInData() const
Junxiao Shi7357ef22016-09-07 02:39:37 +000091 {
Davide Pesavento4ec7a5a2017-02-07 23:13:39 -050092 return m_nInData;
Junxiao Shi7357ef22016-09-07 02:39:37 +000093 }
94
95 FaceStatus&
Junxiao Shi9a53d782017-04-04 20:09:57 +000096 setNInData(uint64_t nInData);
97
Junxiao Shi7357ef22016-09-07 02:39:37 +000098 uint64_t
99 getNInNacks() const
100 {
101 return m_nInNacks;
102 }
103
104 FaceStatus&
105 setNInNacks(uint64_t nInNacks);
106
107 uint64_t
108 getNOutInterests() const
109 {
110 return m_nOutInterests;
111 }
112
113 FaceStatus&
114 setNOutInterests(uint64_t nOutInterests);
115
116 uint64_t
Junxiao Shi9a53d782017-04-04 20:09:57 +0000117 getNOutData() const
Junxiao Shi7357ef22016-09-07 02:39:37 +0000118 {
Davide Pesavento4ec7a5a2017-02-07 23:13:39 -0500119 return m_nOutData;
Junxiao Shi7357ef22016-09-07 02:39:37 +0000120 }
121
122 FaceStatus&
Junxiao Shi9a53d782017-04-04 20:09:57 +0000123 setNOutData(uint64_t nOutData);
124
Junxiao Shi7357ef22016-09-07 02:39:37 +0000125 uint64_t
126 getNOutNacks() const
127 {
128 return m_nOutNacks;
129 }
130
131 FaceStatus&
132 setNOutNacks(uint64_t nOutNacks);
133
134 uint64_t
135 getNInBytes() const
136 {
137 return m_nInBytes;
138 }
139
140 FaceStatus&
141 setNInBytes(uint64_t nInBytes);
142
143 uint64_t
144 getNOutBytes() const
145 {
146 return m_nOutBytes;
147 }
148
149 FaceStatus&
150 setNOutBytes(uint64_t nOutBytes);
151
Junxiao Shi7357ef22016-09-07 02:39:37 +0000152private:
Davide Pesavento4ec7a5a2017-02-07 23:13:39 -0500153 optional<time::milliseconds> m_expirationPeriod;
Junxiao Shi7357ef22016-09-07 02:39:37 +0000154 uint64_t m_nInInterests;
Davide Pesavento4ec7a5a2017-02-07 23:13:39 -0500155 uint64_t m_nInData;
Junxiao Shi7357ef22016-09-07 02:39:37 +0000156 uint64_t m_nInNacks;
157 uint64_t m_nOutInterests;
Davide Pesavento4ec7a5a2017-02-07 23:13:39 -0500158 uint64_t m_nOutData;
Junxiao Shi7357ef22016-09-07 02:39:37 +0000159 uint64_t m_nOutNacks;
160 uint64_t m_nInBytes;
161 uint64_t m_nOutBytes;
Junxiao Shi7357ef22016-09-07 02:39:37 +0000162};
163
Davide Pesavento4ec7a5a2017-02-07 23:13:39 -0500164bool
165operator==(const FaceStatus& a, const FaceStatus& b);
166
167inline bool
168operator!=(const FaceStatus& a, const FaceStatus& b)
169{
170 return !(a == b);
171}
172
Junxiao Shi7357ef22016-09-07 02:39:37 +0000173std::ostream&
174operator<<(std::ostream& os, const FaceStatus& status);
175
176} // namespace nfd
177} // namespace ndn
178
179#endif // NDN_MGMT_NFD_FACE_STATUS_HPP