NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
channel-status.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2019 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 
26 
27 namespace ndn {
28 namespace nfd {
29 
30 BOOST_CONCEPT_ASSERT((StatusDatasetItem<ChannelStatus>));
31 
33 
35 {
36  this->wireDecode(payload);
37 }
38 
39 template<encoding::Tag TAG>
40 size_t
42 {
43  size_t totalLength = 0;
44  totalLength += prependStringBlock(encoder, tlv::nfd::LocalUri, m_localUri);
45  totalLength += encoder.prependVarNumber(totalLength);
46  totalLength += encoder.prependVarNumber(tlv::nfd::ChannelStatus);
47  return totalLength;
48 }
49 
51 
52 const Block&
54 {
55  if (m_wire.hasWire())
56  return m_wire;
57 
58  EncodingEstimator estimator;
59  size_t estimatedSize = wireEncode(estimator);
60 
61  EncodingBuffer buffer(estimatedSize, 0);
62  wireEncode(buffer);
63 
64  m_wire = buffer.block();
65  return m_wire;
66 }
67 
68 void
70 {
71  if (block.type() != tlv::nfd::ChannelStatus) {
72  NDN_THROW(Error("ChannelStatus", block.type()));
73  }
74 
75  m_wire = block;
76  m_wire.parse();
77  auto val = m_wire.elements_begin();
78 
79  if (val != m_wire.elements_end() && val->type() == tlv::nfd::LocalUri) {
80  m_localUri = readString(*val);
81  ++val;
82  }
83  else {
84  NDN_THROW(Error("Missing required LocalUri field"));
85  }
86 }
87 
89 ChannelStatus::setLocalUri(const std::string localUri)
90 {
91  m_wire.reset();
92  m_localUri = localUri;
93  return *this;
94 }
95 
96 bool
98 {
99  return a.getLocalUri() == b.getLocalUri();
100 }
101 
102 std::ostream&
103 operator<<(std::ostream& os, const ChannelStatus& status)
104 {
105  return os << "Channel(LocalUri: " << status.getLocalUri() << ")";
106 }
107 
108 } // namespace nfd
109 } // namespace ndn
Copyright (c) 2011-2015 Regents of the University of California.
const std::string & getLocalUri() const
const Block & wireEncode() const
void parse() const
Parse TLV-VALUE into sub-elements.
Definition: block.cpp:324
NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(ChannelStatus)
Represents a TLV element of the NDN packet format.
Definition: block.hpp:44
size_t prependStringBlock(EncodingImpl< TAG > &encoder, uint32_t type, const std::string &value)
Prepend a TLV element containing a string.
bool hasWire() const noexcept
Check if the Block contains a fully encoded wire representation.
Definition: block.hpp:221
std::string readString(const Block &block)
Read TLV-VALUE of a TLV element as a string.
element_const_iterator elements_begin() const
Equivalent to elements().begin()
Definition: block.hpp:433
#define NDN_THROW(e)
Definition: exception.hpp:61
element_const_iterator elements_end() const
Equivalent to elements().end()
Definition: block.hpp:441
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
void reset() noexcept
Reset the Block to a default-constructed state.
Definition: block.cpp:254
bool operator==(const ChannelStatus &a, const ChannelStatus &b)
std::ostream & operator<<(std::ostream &os, FaceScope faceScope)
concept check for an item in a Status Dataset
Definition: concepts.hpp:115
uint32_t type() const noexcept
Return the TLV-TYPE of the Block.
Definition: block.hpp:277
represents an item in NFD Channel dataset
void wireDecode(const Block &wire)
EncodingImpl< EncoderTag > EncodingBuffer
EncodingImpl< EstimatorTag > EncodingEstimator
ChannelStatus & setLocalUri(const std::string localUri)