NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.0: NDN, CCN, CCNx, content centric networks
API Documentation
nfd-control-parameters.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
23 #include "encoding/tlv-nfd.hpp"
25 #include "util/concepts.hpp"
26 
27 namespace ndn {
28 namespace nfd {
29 
30 //BOOST_CONCEPT_ASSERT((boost::EqualityComparable<ControlParameters>));
31 BOOST_CONCEPT_ASSERT((WireEncodable<ControlParameters>));
32 BOOST_CONCEPT_ASSERT((WireDecodable<ControlParameters>));
33 static_assert(std::is_base_of<tlv::Error, ControlParameters::Error>::value,
34  "ControlParameters::Error must inherit from tlv::Error");
35 
37  : m_hasFields(CONTROL_PARAMETER_UBOUND)
38 {
39 }
40 
42  : m_hasFields(CONTROL_PARAMETER_UBOUND)
43 {
44  wireDecode(block);
45 }
46 
47 template<encoding::Tag TAG>
48 size_t
50 {
51  size_t totalLength = 0;
52 
53  if (this->hasFacePersistency()) {
54  totalLength += prependNonNegativeIntegerBlock(encoder,
55  tlv::nfd::FacePersistency, m_facePersistency);
56  }
57  if (this->hasExpirationPeriod()) {
58  totalLength += prependNonNegativeIntegerBlock(encoder,
59  tlv::nfd::ExpirationPeriod, m_expirationPeriod.count());
60  }
61  if (this->hasStrategy()) {
62  totalLength += prependNestedBlock(encoder, tlv::nfd::Strategy, m_strategy);
63  }
64  if (this->hasFlags()) {
65  totalLength += prependNonNegativeIntegerBlock(encoder, tlv::nfd::Flags, m_flags);
66  }
67  if (this->hasCost()) {
68  totalLength += prependNonNegativeIntegerBlock(encoder, tlv::nfd::Cost, m_cost);
69  }
70  if (this->hasOrigin()) {
71  totalLength += prependNonNegativeIntegerBlock(encoder, tlv::nfd::Origin, m_origin);
72  }
73  if (this->hasLocalControlFeature()) {
74  totalLength += prependNonNegativeIntegerBlock(encoder,
75  tlv::nfd::LocalControlFeature, m_localControlFeature);
76  }
77  if (this->hasUri()) {
78  size_t valLength = encoder.prependByteArray(
79  reinterpret_cast<const uint8_t*>(m_uri.c_str()), m_uri.size());
80  totalLength += valLength;
81  totalLength += encoder.prependVarNumber(valLength);
82  totalLength += encoder.prependVarNumber(tlv::nfd::Uri);
83  }
84  if (this->hasFaceId()) {
85  totalLength += prependNonNegativeIntegerBlock(encoder, tlv::nfd::FaceId, m_faceId);
86  }
87  if (this->hasName()) {
88  totalLength += m_name.wireEncode(encoder);
89  }
90 
91  totalLength += encoder.prependVarNumber(totalLength);
92  totalLength += encoder.prependVarNumber(tlv::nfd::ControlParameters);
93  return totalLength;
94 }
95 
96 template size_t
97 ControlParameters::wireEncode<encoding::EncoderTag>(EncodingImpl<encoding::EncoderTag>&) const;
98 
99 template size_t
100 ControlParameters::wireEncode<encoding::EstimatorTag>(EncodingImpl<encoding::EstimatorTag>&) const;
101 
102 Block
104 {
105  if (m_wire.hasWire())
106  return m_wire;
107 
108  EncodingEstimator estimator;
109  size_t estimatedSize = wireEncode(estimator);
110 
111  EncodingBuffer buffer(estimatedSize, 0);
112  wireEncode(buffer);
113 
114  m_wire = buffer.block();
115  return m_wire;
116 }
117 
118 void
120 {
121  if (block.type() != tlv::nfd::ControlParameters) {
122  BOOST_THROW_EXCEPTION(Error("Expecting TLV-TYPE ControlParameters"));
123  }
124  m_wire = block;
125  m_wire.parse();
127 
128  val = m_wire.find(tlv::Name);
129  m_hasFields[CONTROL_PARAMETER_NAME] = val != m_wire.elements_end();
130  if (this->hasName()) {
131  m_name.wireDecode(*val);
132  }
133 
134  val = m_wire.find(tlv::nfd::FaceId);
135  m_hasFields[CONTROL_PARAMETER_FACE_ID] = val != m_wire.elements_end();
136  if (this->hasFaceId()) {
137  m_faceId = static_cast<uint64_t>(readNonNegativeInteger(*val));
138  }
139 
140  val = m_wire.find(tlv::nfd::Uri);
141  m_hasFields[CONTROL_PARAMETER_URI] = val != m_wire.elements_end();
142  if (this->hasUri()) {
143  m_uri.assign(reinterpret_cast<const char*>(val->value()), val->value_size());
144  }
145 
146  val = m_wire.find(tlv::nfd::LocalControlFeature);
147  m_hasFields[CONTROL_PARAMETER_LOCAL_CONTROL_FEATURE] = val != m_wire.elements_end();
148  if (this->hasLocalControlFeature()) {
149  m_localControlFeature = static_cast<LocalControlFeature>(readNonNegativeInteger(*val));
150  }
151 
152  val = m_wire.find(tlv::nfd::Origin);
153  m_hasFields[CONTROL_PARAMETER_ORIGIN] = val != m_wire.elements_end();
154  if (this->hasOrigin()) {
155  m_origin = static_cast<uint64_t>(readNonNegativeInteger(*val));
156  }
157 
158  val = m_wire.find(tlv::nfd::Cost);
159  m_hasFields[CONTROL_PARAMETER_COST] = val != m_wire.elements_end();
160  if (this->hasCost()) {
161  m_cost = static_cast<uint64_t>(readNonNegativeInteger(*val));
162  }
163 
164  val = m_wire.find(tlv::nfd::Flags);
165  m_hasFields[CONTROL_PARAMETER_FLAGS] = val != m_wire.elements_end();
166  if (this->hasFlags()) {
167  m_flags = static_cast<uint64_t>(readNonNegativeInteger(*val));
168  }
169 
170  val = m_wire.find(tlv::nfd::Strategy);
171  m_hasFields[CONTROL_PARAMETER_STRATEGY] = val != m_wire.elements_end();
172  if (this->hasStrategy()) {
173  val->parse();
174  if (val->elements().empty()) {
175  BOOST_THROW_EXCEPTION(Error("Expecting Strategy/Name"));
176  }
177  else {
178  m_strategy.wireDecode(*val->elements_begin());
179  }
180  }
181 
182  val = m_wire.find(tlv::nfd::ExpirationPeriod);
183  m_hasFields[CONTROL_PARAMETER_EXPIRATION_PERIOD] = val != m_wire.elements_end();
184  if (this->hasExpirationPeriod()) {
185  m_expirationPeriod = time::milliseconds(readNonNegativeInteger(*val));
186  }
187 
188  val = m_wire.find(tlv::nfd::FacePersistency);
189  m_hasFields[CONTROL_PARAMETER_FACE_PERSISTENCY] = val != m_wire.elements_end();
190  if (this->hasFacePersistency()) {
191  m_facePersistency = static_cast<FacePersistency>(readNonNegativeInteger(*val));
192  }
193 }
194 
195 std::ostream&
196 operator<<(std::ostream& os, const ControlParameters& parameters)
197 {
198  os << "ControlParameters(";
199 
200  if (parameters.hasName()) {
201  os << "Name: " << parameters.getName() << ", ";
202  }
203 
204  if (parameters.hasFaceId()) {
205  os << "FaceId: " << parameters.getFaceId() << ", ";
206  }
207 
208  if (parameters.hasUri()) {
209  os << "Uri: " << parameters.getUri() << ", ";
210  }
211 
212  if (parameters.hasLocalControlFeature()) {
213  os << "LocalControlFeature: " << parameters.getLocalControlFeature() << ", ";
214  }
215 
216  if (parameters.hasOrigin()) {
217  os << "Origin: " << parameters.getOrigin() << ", ";
218  }
219 
220  if (parameters.hasCost()) {
221  os << "Cost: " << parameters.getCost() << ", ";
222  }
223 
224  if (parameters.hasFlags()) {
225  os << "Flags: " << parameters.getFlags() << ", ";
226  }
227 
228  if (parameters.hasStrategy()) {
229  os << "Strategy: " << parameters.getStrategy() << ", ";
230  }
231 
232  if (parameters.hasExpirationPeriod()) {
233  os << "ExpirationPeriod: " << parameters.getExpirationPeriod() << ", ";
234  }
235 
236  os << ")";
237  return os;
238 }
239 
240 } // namespace nfd
241 } // namespace ndn
bool hasWire() const
Check if the Block has fully encoded wire.
Definition: block.cpp:471
virtual void wireDecode(const Block &wire) final
Copyright (c) 2011-2015 Regents of the University of California.
size_t prependNonNegativeIntegerBlock(EncodingImpl< TAG > &encoder, uint32_t type, uint64_t value)
Helper to prepend TLV block type type containing non-negative integer value.
represents parameters in a ControlCommand request or response
EncodingImpl< EstimatorTag > EncodingEstimator
element_const_iterator elements_end() const
Definition: block.cpp:595
size_t prependNestedBlock(EncodingImpl< TAG > &encoder, uint32_t type, const U &value)
Prepend a TLV block of type type with WireEncodable value as a value.
void parse() const
Parse wire buffer into subblocks.
Definition: block.cpp:322
Class representing a wire element of NDN-TLV packet format.
Definition: block.hpp:43
uint64_t readNonNegativeInteger(const Block &block)
Helper to read a non-negative integer from a block.
virtual Block wireEncode() const final
EncodingImpl< EncoderTag > EncodingBuffer
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
element_const_iterator find(uint32_t type) const
Definition: block.cpp:420
element_container::const_iterator element_const_iterator
Definition: block.hpp:48
std::ostream & operator<<(std::ostream &os, FaceScope faceScope)
const std::string & getUri() const
const time::milliseconds & getExpirationPeriod() const
size_t wireEncode(EncodingImpl< TAG > &encoder) const
Fast encoding or block size estimation.
Definition: name.cpp:69
void wireDecode(const Block &wire)
Definition: name.cpp:108
LocalControlFeature getLocalControlFeature() const
a concept check for TLV abstraction with .wireEncode method
Definition: concepts.hpp:34
a concept check for TLV abstraction with .wireDecode method and constructible from Block ...
Definition: concepts.hpp:70
uint32_t type() const
Definition: block.hpp:346