NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
internal-transport.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2017, Regents of the University of California,
4  * Arizona Board of Regents,
5  * Colorado State University,
6  * University Pierre & Marie Curie, Sorbonne University,
7  * Washington University in St. Louis,
8  * Beijing Institute of Technology,
9  * The University of Memphis.
10  *
11  * This file is part of NFD (Named Data Networking Forwarding Daemon).
12  * See AUTHORS.md for complete list of NFD authors and contributors.
13  *
14  * NFD is free software: you can redistribute it and/or modify it under the terms
15  * of the GNU General Public License as published by the Free Software Foundation,
16  * either version 3 of the License, or (at your option) any later version.
17  *
18  * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along with
23  * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
26 #ifndef NFD_DAEMON_FACE_INTERNAL_TRANSPORT_HPP
27 #define NFD_DAEMON_FACE_INTERNAL_TRANSPORT_HPP
28 
29 #include "transport.hpp"
30 #include <ndn-cxx/transport/transport.hpp>
31 
32 namespace nfd {
33 namespace face {
34 
38 {
39 public:
40  virtual
41  ~InternalTransportBase() = default;
42 
45  virtual void
46  receiveFromLink(const Block& packet) = 0;
47 
49 
50 protected:
52 };
53 
57 {
58 public:
59  InternalForwarderTransport(const FaceUri& localUri = FaceUri("internal://"),
60  const FaceUri& remoteUri = FaceUri("internal://"),
63 
64  void
65  receiveFromLink(const Block& packet) override;
66 
67 protected:
68  void
69  doClose() override;
70 
71 private:
72  void
73  doSend(Packet&& packet) override;
74 
75 private:
76  NFD_LOG_INCLASS_DECLARE();
77 };
78 
82 {
83 public:
92  void
94 
95  void
96  receiveFromLink(const Block& packet) override;
97 
98  void
99  close() override
100  {
101  }
102 
103  void
104  pause() override
105  {
106  }
107 
108  void
109  resume() override
110  {
111  }
112 
113  void
114  send(const Block& wire) override;
115 
116  void
117  send(const Block& header, const Block& payload) override;
118 
119 private:
120  NFD_LOG_INCLASS_DECLARE();
121 
122  signal::ScopedConnection m_fwToClientTransmitConn;
123  signal::ScopedConnection m_clientToFwTransmitConn;
124  signal::ScopedConnection m_fwTransportStateConn;
125 };
126 
127 } // namespace face
128 } // namespace nfd
129 
130 #endif // NFD_DAEMON_FACE_INTERNAL_TRANSPORT_HPP
implements a client-side transport that can be paired with another
void connectToForwarder(InternalForwarderTransport *forwarderTransport)
connect to a forwarder-side transport
signal::Signal< InternalTransportBase, Block > afterSend
stores a packet along with the remote endpoint
Definition: transport.hpp:122
Represents a TLV element of NDN packet format.
Definition: block.hpp:42
virtual void receiveFromLink(const Block &packet)=0
causes the transport to receive a link-layer packet
provides a lightweight signal / event system
Definition: signal.hpp:50
abstracts a transport that can be paired with another
void receiveFromLink(const Block &packet) override
causes the transport to receive a link-layer packet
#define DECLARE_SIGNAL_EMIT(signalName)
(implementation detail) declares a &#39;emit_signalName&#39; method
Definition: emit.hpp:59
implements a forwarder-side transport that can be paired with another
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
disconnects a Connection automatically upon destruction
void resume() override
resume the transport
represents the underlying protocol and address used by a Face
Definition: face-uri.hpp:44
provides TLV-block delivery service
Definition: transport.hpp:35
void receiveFromLink(const Block &packet) override
causes the transport to receive a link-layer packet
void doClose() override
performs Transport specific operations to close the transport
void pause() override
pause the transport
InternalForwarderTransport(const FaceUri &localUri=FaceUri("internal://"), const FaceUri &remoteUri=FaceUri("internal://"), ndn::nfd::FaceScope scope=ndn::nfd::FACE_SCOPE_LOCAL, ndn::nfd::LinkType linkType=ndn::nfd::LINK_TYPE_POINT_TO_POINT)
void send(const Block &wire) override
send a TLV block through the transport
the lower part of a Face
Definition: transport.hpp:113
void close() override
Close the connection.
virtual ~InternalTransportBase()=default