dummy-client-face.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
22 #include "dummy-client-face.hpp"
23 #include "../lp/packet.hpp"
24 #include "../lp/tags.hpp"
25 #include "../mgmt/nfd/controller.hpp"
26 #include "../mgmt/nfd/control-response.hpp"
27 #include "../transport/transport.hpp"
28 
29 #include <boost/asio/io_service.hpp>
30 
31 namespace ndn {
32 namespace util {
33 
35 {
36 public:
37  void
38  receive(Block block) const
39  {
40  block.encode();
41  if (m_receiveCallback) {
42  m_receiveCallback(block);
43  }
44  }
45 
46  virtual void
47  close() override
48  {
49  }
50 
51  virtual void
52  pause() override
53  {
54  }
55 
56  virtual void
57  resume() override
58  {
59  }
60 
61  virtual void
62  send(const Block& wire) override
63  {
64  onSendBlock(wire);
65  }
66 
67  virtual void
68  send(const Block& header, const Block& payload) override
69  {
70  EncodingBuffer encoder(header.size() + payload.size(), header.size() + payload.size());
71  encoder.appendByteArray(header.wire(), header.size());
72  encoder.appendByteArray(payload.wire(), payload.size());
73 
74  this->send(encoder.block());
75  }
76 
77  boost::asio::io_service&
79  {
80  return *m_ioService;
81  }
82 
83 public:
84  Signal<Transport, Block> onSendBlock;
85 };
86 
87 DummyClientFace::DummyClientFace(const Options& options/* = DummyClientFace::DEFAULT_OPTIONS*/)
88  : Face(make_shared<DummyClientFace::Transport>())
89  , m_internalKeyChain(new KeyChain)
90  , m_keyChain(*m_internalKeyChain)
91 {
92  this->construct(options);
93 }
94 
96  const Options& options/* = DummyClientFace::DEFAULT_OPTIONS*/)
97  : Face(make_shared<DummyClientFace::Transport>(), keyChain)
98  , m_keyChain(keyChain)
99 {
100  this->construct(options);
101 }
102 
103 DummyClientFace::DummyClientFace(boost::asio::io_service& ioService,
104  const Options& options/* = DummyClientFace::DEFAULT_OPTIONS*/)
105  : Face(make_shared<DummyClientFace::Transport>(), ioService)
106  , m_internalKeyChain(new KeyChain)
107  , m_keyChain(*m_internalKeyChain)
108 {
109  this->construct(options);
110 }
111 
112 DummyClientFace::DummyClientFace(boost::asio::io_service& ioService, KeyChain& keyChain,
113  const Options& options/* = DummyClientFace::DEFAULT_OPTIONS*/)
114  : Face(make_shared<DummyClientFace::Transport>(), ioService, keyChain)
115  , m_keyChain(keyChain)
116 {
117  this->construct(options);
118 }
119 
120 void
121 DummyClientFace::construct(const Options& options)
122 {
123  static_pointer_cast<Transport>(getTransport())->onSendBlock.connect([this] (const Block& blockFromDaemon) {
124  Block packet(blockFromDaemon);
125  packet.encode();
126  lp::Packet lpPacket(packet);
127 
128  Buffer::const_iterator begin, end;
129  std::tie(begin, end) = lpPacket.get<lp::FragmentField>();
130  Block block(&*begin, std::distance(begin, end));
131 
132  if (block.type() == tlv::Interest) {
133  shared_ptr<Interest> interest = make_shared<Interest>(block);
134  if (lpPacket.has<lp::NackField>()) {
135  shared_ptr<lp::Nack> nack = make_shared<lp::Nack>(std::move(*interest));
136  nack->setHeader(lpPacket.get<lp::NackField>());
137  if (lpPacket.has<lp::NextHopFaceIdField>()) {
138  nack->setTag(make_shared<lp::NextHopFaceIdTag>(lpPacket.get<lp::NextHopFaceIdField>()));
139  }
140  onSendNack(*nack);
141  }
142  else {
143  if (lpPacket.has<lp::NextHopFaceIdField>()) {
144  interest->setTag(make_shared<lp::NextHopFaceIdTag>(lpPacket.get<lp::NextHopFaceIdField>()));
145  }
146  onSendInterest(*interest);
147  }
148  }
149  else if (block.type() == tlv::Data) {
150  shared_ptr<Data> data = make_shared<Data>(block);
151 
152  if (lpPacket.has<lp::CachePolicyField>()) {
153  data->setTag(make_shared<lp::CachePolicyTag>(lpPacket.get<lp::CachePolicyField>()));
154  }
155 
156  onSendData(*data);
157  }
158  });
159 
160  if (options.enablePacketLogging)
161  this->enablePacketLogging();
162 
163  if (options.enableRegistrationReply)
164  this->enableRegistrationReply();
165 
166  m_processEventsOverride = options.processEventsOverride;
167 }
168 
169 void
170 DummyClientFace::enablePacketLogging()
171 {
172  onSendInterest.connect([this] (const Interest& interest) {
173  this->sentInterests.push_back(interest);
174  });
175  onSendData.connect([this] (const Data& data) {
176  this->sentData.push_back(data);
177  });
178  onSendNack.connect([this] (const lp::Nack& nack) {
179  this->sentNacks.push_back(nack);
180  });
181 }
182 
183 void
184 DummyClientFace::enableRegistrationReply()
185 {
186  onSendInterest.connect([this] (const Interest& interest) {
187  static const Name localhostRegistration("/localhost/nfd/rib");
188  if (!localhostRegistration.isPrefixOf(interest.getName()))
189  return;
190 
191  nfd::ControlParameters params(interest.getName().get(-5).blockFromValue());
192  params.setFaceId(1);
193  params.setOrigin(0);
194  if (interest.getName().get(3) == name::Component("register")) {
195  params.setCost(0);
196  }
197 
199  resp.setCode(200);
200  resp.setBody(params.wireEncode());
201 
202  shared_ptr<Data> data = make_shared<Data>(interest.getName());
203  data->setContent(resp.wireEncode());
204 
205  m_keyChain.sign(*data, security::SigningInfo(security::SigningInfo::SIGNER_TYPE_SHA256));
206 
207  this->getIoService().post([this, data] { this->receive(*data); });
208  });
209 }
210 
211 template<typename Packet>
212 void
213 DummyClientFace::receive(const Packet& packet)
214 {
215  lp::Packet lpPacket(packet.wireEncode());
216 
217  shared_ptr<lp::IncomingFaceIdTag> incomingFaceIdTag =
218  static_cast<const TagHost&>(packet).getTag<lp::IncomingFaceIdTag>();
219  if (incomingFaceIdTag != nullptr) {
220  lpPacket.add<lp::IncomingFaceIdField>(*incomingFaceIdTag);
221  }
222 
223  shared_ptr<lp::NextHopFaceIdTag> nextHopFaceIdTag =
224  static_cast<const TagHost&>(packet).getTag<lp::NextHopFaceIdTag>();
225  if (nextHopFaceIdTag != nullptr) {
226  lpPacket.add<lp::NextHopFaceIdField>(*nextHopFaceIdTag);
227  }
228  static_pointer_cast<Transport>(getTransport())->receive(lpPacket.wireEncode());
229 }
230 
231 template void
232 DummyClientFace::receive<Interest>(const Interest& packet);
233 
234 template void
235 DummyClientFace::receive<Data>(const Data& packet);
236 
237 template<>
238 void
239 DummyClientFace::receive<lp::Nack>(const lp::Nack& nack)
240 {
241  lp::Packet lpPacket;
242  lpPacket.add<lp::NackField>(nack.getHeader());
243  Block interest = nack.getInterest().wireEncode();
244  lpPacket.add<lp::FragmentField>(make_pair(interest.begin(), interest.end()));
245 
246  shared_ptr<lp::IncomingFaceIdTag> incomingFaceIdTag = nack.getTag<lp::IncomingFaceIdTag>();
247  if (incomingFaceIdTag != nullptr) {
248  lpPacket.add<lp::IncomingFaceIdField>(*incomingFaceIdTag);
249  }
250 
251  static_pointer_cast<Transport>(getTransport())->receive(lpPacket.wireEncode());
252 }
253 
254 void
255 DummyClientFace::doProcessEvents(const time::milliseconds& timeout, bool keepThread)
256 {
257  if (m_processEventsOverride != nullptr) {
258  m_processEventsOverride(timeout);
259  }
260  else {
261  this->Face::doProcessEvents(timeout, keepThread);
262  }
263 }
264 
265 } // namespace util
266 } // namespace ndn
size_t wireEncode(EncodingImpl< TAG > &encoder) const
append packet to encoder
Definition: packet.cpp:42
Copyright (c) 2013-2016 Regents of the University of California.
Definition: common.hpp:74
virtual void pause() override
pause the transport
Base class to store tag information (e.g., inside Interest and Data packets)
Definition: tag-host.hpp:34
Packet & add(const typename FIELD::ValueType &value)
add a FIELD with value
Definition: packet.hpp:156
Class representing a wire element of NDN-TLV packet format.
Definition: block.hpp:43
represents an Interest packet
Definition: interest.hpp:42
use sha256 digest, no signer needs to be specified
ReceiveCallback m_receiveCallback
Definition: transport.hpp:124
virtual void send(const Block &header, const Block &payload) override
send two memory blocks through the transport
virtual void doProcessEvents(const time::milliseconds &timeout, bool keepThread)
Definition: face.cpp:442
virtual void send(const Block &wire) override
send a TLV block through the transport
boost::asio::io_service & getIoService()
represents a Network Nack
Definition: nack.hpp:40
options for DummyClientFace
provides a tag type for simple types
Definition: tag.hpp:58
size_t size() const
Definition: block.cpp:504
virtual void close() override
Close the connection.
ndn::mgmt::ControlResponse ControlResponse
EncodingImpl< EncoderTag > EncodingBuffer
DummyClientFace(const Options &options=Options())
Create a dummy face with internal IO service.
shared_ptr< Transport > getTransport()
Definition: face.cpp:161
Provide a communication channel with local or remote NDN forwarder.
Definition: face.hpp:125
boost::asio::io_service * m_ioService
Definition: transport.hpp:121
Signal< DummyClientFace, Data > onSendData
emits whenever a Data packet is sent
provides TLV-block delivery service
Definition: transport.hpp:40
size_t appendByteArray(const uint8_t *array, size_t length)
Append a byte array array of length length.
Definition: encoder.cpp:135
a client-side face for unit testing
ControlResponse & setBody(const Block &body)
void encode()
Encode subblocks into wire buffer.
Definition: block.cpp:355
const uint8_t * wire() const
Definition: block.cpp:495
represents a Data packet
Definition: data.hpp:37
ControlResponse & setCode(uint32_t code)
virtual void resume() override
resume the transport
Signal< Transport, Block > onSendBlock
virtual void connect(boost::asio::io_service &ioService, const ReceiveCallback &receiveCallback)
asynchronously open the connection
Definition: transport.cpp:44