name-lsa.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2018, The University of Memphis,
4  * Regents of the University of California,
5  * Arizona Board of Regents.
6  *
7  * This file is part of NLSR (Named-data Link State Routing).
8  * See AUTHORS.md for complete list of NLSR authors and contributors.
9  *
10  * NLSR is free software: you can redistribute it and/or modify it under the terms
11  * of the GNU General Public License as published by the Free Software Foundation,
12  * either version 3 of the License, or (at your option) any later version.
13  *
14  * NLSR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
15  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
16  * PURPOSE. See the GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License along with
19  * NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
20  */
21 
22 #include "name-lsa.hpp"
23 #include "tlv-nlsr.hpp"
24 
25 #include <ndn-cxx/util/concepts.hpp>
26 #include <ndn-cxx/encoding/block-helpers.hpp>
27 
28 namespace nlsr {
29 namespace tlv {
30 
31 BOOST_CONCEPT_ASSERT((ndn::WireEncodable<NameLsa>));
32 BOOST_CONCEPT_ASSERT((ndn::WireDecodable<NameLsa>));
33 static_assert(std::is_base_of<ndn::tlv::Error, NameLsa::Error>::value,
34  "NameLsa::Error must inherit from tlv::Error");
35 
37  : m_hasNames(false)
38 {
39 }
40 
41 NameLsa::NameLsa(const ndn::Block& block)
42 {
43  wireDecode(block);
44 }
45 
46 template<ndn::encoding::Tag TAG>
47 size_t
48 NameLsa::wireEncode(ndn::EncodingImpl<TAG>& block) const
49 {
50  size_t totalLength = 0;
51 
52  for (std::list<ndn::Name>::const_reverse_iterator it = m_names.rbegin();
53  it != m_names.rend(); ++it) {
54  totalLength += it->wireEncode(block);
55  }
56 
57  totalLength += m_lsaInfo.wireEncode(block);
58 
59  totalLength += block.prependVarNumber(totalLength);
60  totalLength += block.prependVarNumber(ndn::tlv::nlsr::NameLsa);
61 
62  return totalLength;
63 }
64 
66 
67 const ndn::Block&
69 {
70  if (m_wire.hasWire()) {
71  return m_wire;
72  }
73 
74  ndn::EncodingEstimator estimator;
75  size_t estimatedSize = wireEncode(estimator);
76 
77  ndn::EncodingBuffer buffer(estimatedSize, 0);
78  wireEncode(buffer);
79 
80  m_wire = buffer.block();
81 
82  return m_wire;
83 }
84 
85 void
86 NameLsa::wireDecode(const ndn::Block& wire)
87 {
88  m_hasNames = false;
89  m_names.clear();
90 
91  m_wire = wire;
92 
93  if (m_wire.type() != ndn::tlv::nlsr::NameLsa) {
94  BOOST_THROW_EXCEPTION(Error("Expected NameLsa Block, but Block is of a different type: #" +
95  ndn::to_string(m_wire.type())));
96  }
97 
98  m_wire.parse();
99 
100  ndn::Block::element_const_iterator val = m_wire.elements_begin();
101 
102  if (val != m_wire.elements_end() && val->type() == ndn::tlv::nlsr::LsaInfo) {
103  m_lsaInfo.wireDecode(*val);
104  ++val;
105  }
106  else {
107  BOOST_THROW_EXCEPTION(Error("Missing required LsaInfo field"));
108  }
109 
110  for (; val != m_wire.elements_end(); ++val) {
111  if (val->type() == ndn::tlv::Name) {
112  m_names.push_back(ndn::Name(*val));
113  m_hasNames = true;
114  }
115  else {
116  BOOST_THROW_EXCEPTION(Error("Expected Name Block, but Block is of a different type: #" +
117  ndn::to_string(m_wire.type())));
118  }
119  }
120 }
121 
122 std::ostream&
123 operator<<(std::ostream& os, const NameLsa& nameLsa)
124 {
125  os << "NameLsa("
126  << nameLsa.getLsaInfo();
127 
128  for (const auto& name : nameLsa) {
129  os << ", Name: " << name;
130  }
131 
132  os << ")";
133 
134  return os;
135 }
136 
137 } // namespace tlv
138 } // namespace nlsr
void wireDecode(const ndn::Block &wire)
Populate this object by decoding the one contained in the given block.
Definition: name-lsa.cpp:86
NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(AdjacencyLsa)
Data abstraction for NameLsa.
Definition: name-lsa.hpp:47
const LsaInfo & getLsaInfo() const
Definition: name-lsa.hpp:69
Copyright (c) 2014-2019, The University of Memphis, Regents of the University of California, Arizona Board of Regents.
const ndn::Block & wireEncode() const
Create a TLV encoding of this object.
Definition: name-lsa.cpp:68
std::ostream & operator<<(std::ostream &os, const AdjacencyLsa &adjacencyLsa)
size_t wireEncode(ndn::EncodingImpl< TAG > &block) const
Encodes LSA info using the method in TAG.
Definition: lsa-info.cpp:52
void wireDecode(const ndn::Block &wire)
Populate this object by decoding the one contained in the given block.
Definition: lsa-info.cpp:96