NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: 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-2017 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 
25 #include "../../encoding/block.hpp"
26 
27 namespace ndn {
28 namespace nfd {
29 
36 {
37 public:
38  class Error : public tlv::Error
39  {
40  public:
41  explicit
42  Error(const std::string& what)
43  : tlv::Error(what)
44  {
45  }
46  };
47 
48  ChannelStatus();
49 
50  explicit
51  ChannelStatus(const Block& payload);
52 
53  template<encoding::Tag TAG>
54  size_t
55  wireEncode(EncodingImpl<TAG>& encoder) const;
56 
57  const Block&
58  wireEncode() const;
59 
60  void
61  wireDecode(const Block& wire);
62 
63 public: // getters & setters
64  const std::string&
65  getLocalUri() const
66  {
67  return m_localUri;
68  }
69 
71  setLocalUri(const std::string localUri);
72 
73 private:
74  std::string m_localUri;
75 
76  mutable Block m_wire;
77 };
78 
80 
81 bool
82 operator==(const ChannelStatus& a, const ChannelStatus& b);
83 
84 inline bool
86 {
87  return !(a == b);
88 }
89 
90 std::ostream&
91 operator<<(std::ostream& os, const ChannelStatus& status);
92 
93 } // namespace nfd
94 } // namespace ndn
95 
96 #endif // NDN_MGMT_NFD_CHANNEL_STATUS_HPP
Copyright (c) 2011-2015 Regents of the University of California.
bool operator!=(const ChannelStatus &a, const ChannelStatus &b)
Error(const std::string &what)
Represents a TLV element of NDN packet format.
Definition: block.hpp:42
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
const std::string & getLocalUri() const
bool operator==(const ChannelStatus &a, const ChannelStatus &b)
const Block & wireEncode() const
std::ostream & operator<<(std::ostream &os, FaceScope faceScope)
NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(ChannelStatus)
represents an item in NFD Channel dataset
void wireDecode(const Block &wire)
represents an error in TLV encoding or decoding
Definition: tlv.hpp:50
ChannelStatus & setLocalUri(const std::string localUri)