nack-header.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2023 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  * @author Eric Newberry <enewberry@email.arizona.edu>
22  */
23 
24 #ifndef NDN_CXX_LP_NACK_HEADER_HPP
25 #define NDN_CXX_LP_NACK_HEADER_HPP
26 
29 #include "ndn-cxx/lp/tlv.hpp"
30 
31 namespace ndn::lp {
32 
36 enum class NackReason {
37  NONE = 0,
38  CONGESTION = 50,
39  DUPLICATE = 100,
40  NO_ROUTE = 150
41 };
42 
43 std::ostream&
44 operator<<(std::ostream& os, NackReason reason);
45 
51 bool
53 
58 {
59 public:
60  NackHeader();
61 
62  explicit
63  NackHeader(const Block& block);
64 
65  template<encoding::Tag TAG>
66  size_t
67  wireEncode(EncodingImpl<TAG>& encoder) const;
68 
69  const Block&
70  wireEncode() const;
71 
72  void
73  wireDecode(const Block& wire);
74 
75 public: // reason
81  getReason() const;
82 
87  NackHeader&
88  setReason(NackReason reason);
89 
90 private:
91  NackReason m_reason;
92  mutable Block m_wire;
93 };
94 
96 
97 } // namespace ndn::lp
98 
99 #endif // NDN_CXX_LP_NACK_HEADER_HPP
Represents a TLV element of the NDN packet format.
Definition: block.hpp:45
Represents a Network Nack header.
Definition: nack-header.hpp:58
const Block & wireEncode() const
Definition: nack-header.cpp:80
NackHeader & setReason(NackReason reason)
Set reason code.
NackReason getReason() const
Get reason code.
void wireDecode(const Block &wire)
Definition: nack-header.cpp:98
#define NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ClassName)
Contains classes and functions related to NDNLPv2.
NackReason
Indicates the reason type of a Network Nack.
Definition: nack-header.hpp:36
std::ostream & operator<<(std::ostream &os, CachePolicyType policy)
bool isLessSevere(lp::NackReason x, lp::NackReason y)
Compare NackReason according to severity.
Definition: nack-header.cpp:44