channel-status.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 
22 #ifndef NDN_CXX_MGMT_NFD_CHANNEL_STATUS_HPP
23 #define NDN_CXX_MGMT_NFD_CHANNEL_STATUS_HPP
24 
26 
27 namespace ndn::nfd {
28 
35 {
36 public:
37  class Error : public tlv::Error
38  {
39  public:
40  using tlv::Error::Error;
41  };
42 
44 
45  explicit
46  ChannelStatus(const Block& payload);
47 
48  template<encoding::Tag TAG>
49  size_t
50  wireEncode(EncodingImpl<TAG>& encoder) const;
51 
52  const Block&
53  wireEncode() const;
54 
55  void
56  wireDecode(const Block& wire);
57 
58 public: // getters & setters
59  const std::string&
60  getLocalUri() const
61  {
62  return m_localUri;
63  }
64 
66  setLocalUri(const std::string& localUri);
67 
68 private:
69  std::string m_localUri;
70 
71  mutable Block m_wire;
72 };
73 
75 
76 bool
77 operator==(const ChannelStatus& a, const ChannelStatus& b);
78 
79 inline bool
81 {
82  return !(a == b);
83 }
84 
85 std::ostream&
86 operator<<(std::ostream& os, const ChannelStatus& status);
87 
88 } // namespace ndn::nfd
89 
90 #endif // NDN_CXX_MGMT_NFD_CHANNEL_STATUS_HPP
Represents a TLV element of the NDN packet format.
Definition: block.hpp:45
Represents an item in NFD Channel dataset.
const std::string & getLocalUri() const
ChannelStatus & setLocalUri(const std::string &localUri)
void wireDecode(const Block &wire)
const Block & wireEncode() const
Represents an error in TLV encoding or decoding.
Definition: tlv.hpp:54
Error(const char *expectedType, uint32_t actualType)
Definition: tlv.cpp:28
#define NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ClassName)
Contains classes and functions related to the NFD Management protocol.
bool operator!=(const ChannelStatus &a, const ChannelStatus &b)
std::ostream & operator<<(std::ostream &os, FaceScope faceScope)
bool operator==(const ChannelStatus &a, const ChannelStatus &b)