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-2020, 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 
31 #include <ndn-cxx/transport/transport.hpp>
32 
33 namespace nfd {
34 namespace face {
35 
39 {
40 public:
41  virtual
42  ~InternalTransportBase() = default;
43 
44  virtual void
45  receivePacket(const Block& packet) = 0;
46 };
47 
51 {
52 public:
53  explicit
54  InternalForwarderTransport(const FaceUri& localUri = FaceUri("internal://"),
55  const FaceUri& remoteUri = FaceUri("internal://"),
56  ndn::nfd::FaceScope scope = ndn::nfd::FACE_SCOPE_LOCAL,
57  ndn::nfd::LinkType linkType = ndn::nfd::LINK_TYPE_POINT_TO_POINT);
58 
59  void
61  {
62  m_peer = peer;
63  }
64 
65  void
66  receivePacket(const Block& packet) final;
67 
68 protected:
69  void
70  doClose() final;
71 
72 private:
73  void
74  doSend(const Block& packet) final;
75 
76 private:
78 
79  InternalTransportBase* m_peer = nullptr;
80 };
81 
84 class InternalClientTransport final : public ndn::Transport, public InternalTransportBase
85 {
86 public:
87  ~InternalClientTransport() final;
88 
97  void
98  connectToForwarder(InternalForwarderTransport* forwarder);
99 
100  void
101  receivePacket(const Block& packet) final;
102 
103  void
104  send(const Block& wire) final;
105 
106  void
107  send(const Block& header, const Block& payload) final;
108 
109  void
110  close() final
111  {
112  }
113 
114  void
115  pause() final
116  {
117  }
118 
119  void
120  resume() final
121  {
122  }
123 
124 private:
126 
127  InternalForwarderTransport* m_forwarder = nullptr;
128  signal::ScopedConnection m_fwTransportStateConn;
129 };
130 
131 } // namespace face
132 } // namespace nfd
133 
134 #endif // NFD_DAEMON_FACE_INTERNAL_TRANSPORT_HPP
virtual ~InternalTransportBase()=default
Implements a forwarder-side transport that can be paired with another transport.
#define NFD_LOG_MEMBER_DECL()
Definition: logger.hpp:32
The lower half of a Face.
Definition: transport.hpp:108
virtual void receivePacket(const Block &packet)=0
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
void setPeer(InternalTransportBase *peer)
Abstracts a transport that can be paired with another.
Implements a client-side transport that can be paired with an InternalForwarderTransport.