dummy-client-face.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 
23 #include "ndn-cxx/impl/lp-field-tag.hpp"
24 #include "ndn-cxx/lp/packet.hpp"
25 #include "ndn-cxx/lp/tags.hpp"
29 
30 #include <boost/asio/io_service.hpp>
31 
32 namespace ndn {
33 namespace util {
34 
35 class DummyClientFace::Transport : public ndn::Transport
36 {
37 public:
38  void
39  receive(Block block) const
40  {
41  block.encode();
42  if (m_receiveCallback) {
43  m_receiveCallback(block);
44  }
45  }
46 
47  void
48  close() override
49  {
50  }
51 
52  void
53  pause() override
54  {
55  }
56 
57  void
58  resume() override
59  {
60  }
61 
62  void
63  send(const Block& wire) override
64  {
65  onSendBlock(wire);
66  }
67 
68  void
69  send(const Block& header, const Block& payload) override
70  {
71  EncodingBuffer encoder(header.size() + payload.size(), header.size() + payload.size());
72  encoder.appendByteArray(header.wire(), header.size());
73  encoder.appendByteArray(payload.wire(), payload.size());
74 
75  this->send(encoder.block());
76  }
77 
78  boost::asio::io_service&
79  getIoService()
80  {
81  return *m_ioService;
82  }
83 
84 public:
85  Signal<Transport, Block> onSendBlock;
86 };
87 
88 struct DummyClientFace::BroadcastLink
89 {
90  std::vector<DummyClientFace*> faces;
91 };
92 
94  : Error("Face has already been linked to another face")
95 {
96 }
97 
99  : Face(make_shared<DummyClientFace::Transport>())
100  , m_internalKeyChain(make_unique<KeyChain>())
101  , m_keyChain(*m_internalKeyChain)
102 {
103  this->construct(options);
104 }
105 
106 DummyClientFace::DummyClientFace(KeyChain& keyChain, const Options& options)
107  : Face(make_shared<DummyClientFace::Transport>(), keyChain)
108  , m_keyChain(keyChain)
109 {
110  this->construct(options);
111 }
112 
113 DummyClientFace::DummyClientFace(boost::asio::io_service& ioService, const Options& options)
114  : Face(make_shared<DummyClientFace::Transport>(), ioService)
115  , m_internalKeyChain(make_unique<KeyChain>())
116  , m_keyChain(*m_internalKeyChain)
117 {
118  this->construct(options);
119 }
120 
121 DummyClientFace::DummyClientFace(boost::asio::io_service& ioService, KeyChain& keyChain, const Options& options)
122  : Face(make_shared<DummyClientFace::Transport>(), ioService, keyChain)
123  , m_keyChain(keyChain)
124 {
125  this->construct(options);
126 }
127 
129 {
130  unlink();
131 }
132 
133 void
134 DummyClientFace::construct(const Options& options)
135 {
136  static_pointer_cast<Transport>(getTransport())->onSendBlock.connect([this] (const Block& blockFromDaemon) {
137  Block packet(blockFromDaemon);
138  packet.encode();
139  lp::Packet lpPacket(packet);
140 
141  Buffer::const_iterator begin, end;
142  std::tie(begin, end) = lpPacket.get<lp::FragmentField>();
143  Block block(&*begin, std::distance(begin, end));
144 
145  if (block.type() == tlv::Interest) {
146  shared_ptr<Interest> interest = make_shared<Interest>(block);
147  if (lpPacket.has<lp::NackField>()) {
148  shared_ptr<lp::Nack> nack = make_shared<lp::Nack>(std::move(*interest));
149  nack->setHeader(lpPacket.get<lp::NackField>());
150  addTagFromField<lp::CongestionMarkTag, lp::CongestionMarkField>(*nack, lpPacket);
151  onSendNack(*nack);
152  }
153  else {
154  addTagFromField<lp::NextHopFaceIdTag, lp::NextHopFaceIdField>(*interest, lpPacket);
155  addTagFromField<lp::CongestionMarkTag, lp::CongestionMarkField>(*interest, lpPacket);
156  onSendInterest(*interest);
157  }
158  }
159  else if (block.type() == tlv::Data) {
160  shared_ptr<Data> data = make_shared<Data>(block);
161  addTagFromField<lp::CachePolicyTag, lp::CachePolicyField>(*data, lpPacket);
162  addTagFromField<lp::CongestionMarkTag, lp::CongestionMarkField>(*data, lpPacket);
163  onSendData(*data);
164  }
165  });
166 
167  if (options.enablePacketLogging)
168  this->enablePacketLogging();
169 
170  if (options.enableRegistrationReply)
171  this->enableRegistrationReply();
172 
173  m_processEventsOverride = options.processEventsOverride;
174 
175  enableBroadcastLink();
176 }
177 
178 void
179 DummyClientFace::enableBroadcastLink()
180 {
181  this->onSendInterest.connect([this] (const Interest& interest) {
182  if (m_bcastLink != nullptr) {
183  for (auto otherFace : m_bcastLink->faces) {
184  if (otherFace != this) {
185  otherFace->receive(interest);
186  }
187  }
188  }
189  });
190  this->onSendData.connect([this] (const Data& data) {
191  if (m_bcastLink != nullptr) {
192  for (auto otherFace : m_bcastLink->faces) {
193  if (otherFace != this) {
194  otherFace->receive(data);
195  }
196  }
197  }
198  });
199  this->onSendNack.connect([this] (const lp::Nack& nack) {
200  if (m_bcastLink != nullptr) {
201  for (auto otherFace : m_bcastLink->faces) {
202  if (otherFace != this) {
203  otherFace->receive(nack);
204  }
205  }
206  }
207  });
208 }
209 
210 void
211 DummyClientFace::enablePacketLogging()
212 {
213  onSendInterest.connect([this] (const Interest& interest) {
214  this->sentInterests.push_back(interest);
215  });
216  onSendData.connect([this] (const Data& data) {
217  this->sentData.push_back(data);
218  });
219  onSendNack.connect([this] (const lp::Nack& nack) {
220  this->sentNacks.push_back(nack);
221  });
222 }
223 
224 void
225 DummyClientFace::enableRegistrationReply()
226 {
227  onSendInterest.connect([this] (const Interest& interest) {
228  static const Name localhostRegistration("/localhost/nfd/rib");
229  if (!localhostRegistration.isPrefixOf(interest.getName()))
230  return;
231 
232  nfd::ControlParameters params(interest.getName().get(-5).blockFromValue());
233  params.setFaceId(1);
235  if (interest.getName().get(3) == name::Component("register")) {
236  params.setCost(0);
237  }
238 
240  resp.setCode(200);
241  resp.setBody(params.wireEncode());
242 
243  shared_ptr<Data> data = make_shared<Data>(interest.getName());
244  data->setContent(resp.wireEncode());
245 
247 
248  this->getIoService().post([this, data] { this->receive(*data); });
249  });
250 }
251 
252 void
254 {
255  lp::Packet lpPacket(interest.wireEncode());
256 
257  addFieldFromTag<lp::IncomingFaceIdField, lp::IncomingFaceIdTag>(lpPacket, interest);
258  addFieldFromTag<lp::NextHopFaceIdField, lp::NextHopFaceIdTag>(lpPacket, interest);
259  addFieldFromTag<lp::CongestionMarkField, lp::CongestionMarkTag>(lpPacket, interest);
260 
261  static_pointer_cast<Transport>(getTransport())->receive(lpPacket.wireEncode());
262 }
263 
264 void
266 {
267  lp::Packet lpPacket(data.wireEncode());
268 
269  addFieldFromTag<lp::IncomingFaceIdField, lp::IncomingFaceIdTag>(lpPacket, data);
270  addFieldFromTag<lp::CongestionMarkField, lp::CongestionMarkTag>(lpPacket, data);
271 
272  static_pointer_cast<Transport>(getTransport())->receive(lpPacket.wireEncode());
273 }
274 
275 void
277 {
278  lp::Packet lpPacket;
279  lpPacket.add<lp::NackField>(nack.getHeader());
280  Block interest = nack.getInterest().wireEncode();
281  lpPacket.add<lp::FragmentField>(make_pair(interest.begin(), interest.end()));
282 
283  addFieldFromTag<lp::IncomingFaceIdField, lp::IncomingFaceIdTag>(lpPacket, nack);
284  addFieldFromTag<lp::CongestionMarkField, lp::CongestionMarkTag>(lpPacket, nack);
285 
286  static_pointer_cast<Transport>(getTransport())->receive(lpPacket.wireEncode());
287 }
288 
289 void
291 {
292  if (m_bcastLink != nullptr && other.m_bcastLink != nullptr) {
293  if (m_bcastLink != other.m_bcastLink) {
294  // already on different links
296  }
297  }
298  else if (m_bcastLink == nullptr && other.m_bcastLink != nullptr) {
299  m_bcastLink = other.m_bcastLink;
300  m_bcastLink->faces.push_back(this);
301  }
302  else if (m_bcastLink != nullptr && other.m_bcastLink == nullptr) {
303  other.m_bcastLink = m_bcastLink;
304  m_bcastLink->faces.push_back(&other);
305  }
306  else {
307  m_bcastLink = other.m_bcastLink = make_shared<BroadcastLink>();
308  m_bcastLink->faces.push_back(this);
309  m_bcastLink->faces.push_back(&other);
310  }
311 }
312 
313 void
315 {
316  if (m_bcastLink == nullptr) {
317  return;
318  }
319 
320  auto it = std::find(m_bcastLink->faces.begin(), m_bcastLink->faces.end(), this);
321  BOOST_ASSERT(it != m_bcastLink->faces.end());
322  m_bcastLink->faces.erase(it);
323 
324  if (m_bcastLink->faces.size() == 1) {
325  m_bcastLink->faces[0]->m_bcastLink = nullptr;
326  m_bcastLink->faces.clear();
327  }
328  m_bcastLink = nullptr;
329 }
330 
331 void
332 DummyClientFace::doProcessEvents(time::milliseconds timeout, bool keepThread)
333 {
334  if (m_processEventsOverride != nullptr) {
335  m_processEventsOverride(timeout);
336  }
337  else {
338  this->Face::doProcessEvents(timeout, keepThread);
339  }
340 }
341 
342 } // namespace util
343 } // namespace ndn
bool enableRegistrationReply
if true, prefix registration command will be automatically replied with a successful response ...
ControlParameters & setFaceId(uint64_t faceId)
std::vector< lp::Nack > sentNacks
Nacks sent out of this DummyClientFace.
const Name & getName() const
Definition: interest.hpp:134
Definition: data.cpp:26
virtual void doProcessEvents(time::milliseconds timeout, bool keepThread)
Definition: face.cpp:300
const NackHeader & getHeader() const
Definition: nack.hpp:63
Signal< DummyClientFace, Interest > onSendInterest
emits whenever an Interest is sent
represents parameters in a ControlCommand request or response
std::vector< Interest > sentInterests
Interests sent out of this DummyClientFace.
Packet & add(const typename FIELD::ValueType &value)
add a FIELD with value
Definition: packet.hpp:148
const Interest & getInterest() const
Definition: nack.hpp:51
Represents a TLV element of NDN packet format.
Definition: block.hpp:42
Represents an Interest packet.
Definition: interest.hpp:44
use sha256 digest, no signer needs to be specified
const Block & wireEncode() const
std::vector< Data > sentData
Data sent out of this DummyClientFace.
Signing parameters passed to KeyChain.
represents a Network Nack
Definition: nack.hpp:38
#define NDN_THROW(e)
Definition: exception.hpp:61
options for DummyClientFace
Declare a field.
Definition: field-decl.hpp:179
size_t size() const
Return the size of the encoded wire, i.e.
Definition: block.cpp:289
size_t wireEncode(EncodingImpl< TAG > &encoder, bool wantUnsignedPortionOnly=false) const
Prepend wire encoding to encoder in NDN Packet Format v0.2.
Definition: data.cpp:48
DummyClientFace(const Options &options=Options())
Create a dummy face with internal IO service.
Signal< DummyClientFace, lp::Nack > onSendNack
emits whenever a Nack is sent
Block blockFromValue() const
Definition: block.cpp:313
shared_ptr< Transport > getTransport()
Definition: face.cpp:171
Provide a communication channel with local or remote NDN forwarder.
Definition: face.hpp:93
size_t wireEncode(EncodingImpl< TAG > &encoder) const
Prepend wire encoding to encoder.
Definition: interest.cpp:90
Signal< DummyClientFace, Data > onSendData
emits whenever a Data packet is sent
void unlink()
unlink the broadcast media if previously linked
Represents an absolute name.
Definition: name.hpp:43
void receive(const Interest &interest)
cause the Face to receive an interest
bool isPrefixOf(const Name &other) const
Check if this name is a prefix of another name.
Definition: name.cpp:251
void linkTo(DummyClientFace &other)
link another DummyClientFace through a broadcast media
provides TLV-block delivery service
Definition: transport.hpp:35
boost::asio::io_service & getIoService()
Definition: face.hpp:467
size_t appendByteArray(const uint8_t *array, size_t length)
Append a byte array array of length length.
Definition: encoder.cpp:128
a client-side face for unit testing
ControlParameters & setCost(uint64_t cost)
Represents a name component.
ControlResponse & setBody(const Block &body)
void encode()
Encode sub-elements into TLV-VALUE.
Definition: block.cpp:352
const uint8_t * wire() const
Return a raw pointer to the beginning of the encoded wire.
Definition: block.cpp:280
ControlParameters & setOrigin(RouteOrigin origin)
ControlCommand response.
Represents a Data packet.
Definition: data.hpp:35
const Component & get(ssize_t i) const
Get the component at the given index.
Definition: name.hpp:157
ControlResponse & setCode(uint32_t code)
EncodingImpl< EncoderTag > EncodingBuffer
bool enablePacketLogging
if true, packets sent out of DummyClientFace will be appended to a container
std::function< void(time::milliseconds)> processEventsOverride
if not empty, face.processEvents() will be overridden by this function