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-2022, 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::face {
34 
38 {
39 public:
40  virtual
42 
43  virtual void
44  receivePacket(const Block& packet) = 0;
45 };
46 
50 {
51 public:
52  explicit
53  InternalForwarderTransport(const FaceUri& localUri = FaceUri("internal://"),
54  const FaceUri& remoteUri = FaceUri("internal://"),
55  ndn::nfd::FaceScope scope = ndn::nfd::FACE_SCOPE_LOCAL,
56  ndn::nfd::LinkType linkType = ndn::nfd::LINK_TYPE_POINT_TO_POINT);
57 
58  void
60  {
61  m_peer = peer;
62  }
63 
64  void
65  receivePacket(const Block& packet) final;
66 
67 protected:
68  void
69  doClose() final;
70 
71 private:
72  void
73  doSend(const Block& packet) final;
74 
75 private:
77 
78  InternalTransportBase* m_peer = nullptr;
79 };
80 
84 {
85 public:
86  ~InternalClientTransport() final;
87 
96  void
97  connectToForwarder(InternalForwarderTransport* forwarder);
98 
99  void
100  receivePacket(const Block& packet) final;
101 
102  void
103  send(const Block& block) final;
104 
105  void
106  close() final
107  {
108  }
109 
110  void
111  pause() final
112  {
113  }
114 
115  void
116  resume() final
117  {
118  }
119 
120 private:
122 
123  InternalForwarderTransport* m_forwarder = nullptr;
124  signal::ScopedConnection m_fwTransportStateConn;
125 };
126 
127 } // namespace nfd::face
128 
129 #endif // NFD_DAEMON_FACE_INTERNAL_TRANSPORT_HPP
Implements a client-side transport that can be paired with an InternalForwarderTransport.
Implements a forwarder-side transport that can be paired with another 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 setPeer(InternalTransportBase *peer)
void doClose() final
Performs Transport specific operations to close the transport.
void receivePacket(const Block &packet) final
Abstracts a transport that can be paired with another.
virtual ~InternalTransportBase()=default
virtual void receivePacket(const Block &packet)=0
The lower half of a Face.
Definition: transport.hpp:114
void send(const Block &packet)
Send a link-layer packet.
Definition: transport.cpp:80
#define NFD_LOG_MEMBER_DECL()
Definition: logger.hpp:32
Definition: dns-srv.cpp:44