NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2018 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_MGMT_NFD_CHANNEL_STATUS_HPP
23 #define NDN_MGMT_NFD_CHANNEL_STATUS_HPP
24 
26 
27 namespace ndn {
28 namespace nfd {
29 
36 {
37 public:
38  class Error : public tlv::Error
39  {
40  public:
41  using tlv::Error::Error;
42  };
43 
45 
46  explicit
47  ChannelStatus(const Block& payload);
48 
49  template<encoding::Tag TAG>
50  size_t
51  wireEncode(EncodingImpl<TAG>& encoder) const;
52 
53  const Block&
54  wireEncode() const;
55 
56  void
57  wireDecode(const Block& wire);
58 
59 public: // getters & setters
60  const std::string&
61  getLocalUri() const
62  {
63  return m_localUri;
64  }
65 
67  setLocalUri(const std::string localUri);
68 
69 private:
70  std::string m_localUri;
71 
72  mutable Block m_wire;
73 };
74 
76 
77 bool
78 operator==(const ChannelStatus& a, const ChannelStatus& b);
79 
80 inline bool
82 {
83  return !(a == b);
84 }
85 
86 std::ostream&
87 operator<<(std::ostream& os, const ChannelStatus& status);
88 
89 } // namespace nfd
90 } // namespace ndn
91 
92 #endif // NDN_MGMT_NFD_CHANNEL_STATUS_HPP
ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ChannelStatus)
ndn::nfd::operator<<
std::ostream & operator<<(std::ostream &os, FaceScope faceScope)
Definition: nfd-constants.cpp:36
block.hpp
ndn::nfd::ChannelStatus
represents an item in NFD Channel dataset
Definition: channel-status.hpp:36
ndn::nfd::ChannelStatus::Error
Definition: channel-status.hpp:39
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
ndn::nfd::ChannelStatus::wireDecode
void wireDecode(const Block &wire)
Definition: channel-status.cpp:69
ndn::nfd::ChannelStatus::getLocalUri
const std::string & getLocalUri() const
Definition: channel-status.hpp:61
ndn::nfd::ChannelStatus::ChannelStatus
ChannelStatus()
ndn::nfd::ChannelStatus::setLocalUri
ChannelStatus & setLocalUri(const std::string localUri)
Definition: channel-status.cpp:89
ndn::tlv::nfd::ChannelStatus
@ ChannelStatus
Definition: tlv-nfd.hpp:65
ndn::encoding::EncodingImpl
Definition: encoding-buffer-fwd.hpp:36
ndn::Block
Represents a TLV element of NDN packet format.
Definition: block.hpp:43
ndn::nfd::operator!=
bool operator!=(const ChannelStatus &a, const ChannelStatus &b)
Definition: channel-status.hpp:81
ndn::nfd::operator==
bool operator==(const ChannelStatus &a, const ChannelStatus &b)
Definition: channel-status.cpp:97
ndn::tlv::Error
represents an error in TLV encoding or decoding
Definition: tlv.hpp:53
ndn::nfd::ChannelStatus::wireEncode
const Block & wireEncode() const
Definition: channel-status.cpp:53
ndn::tlv::Error::Error
Error(const char *expectedType, uint32_t actualType)
Definition: tlv.cpp:27
ndn
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-strategy-choice-helper.hpp:34