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-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 
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://"),
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 
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& block) final;
105 
106  void
107  close() final
108  {
109  }
110 
111  void
112  pause() final
113  {
114  }
115 
116  void
117  resume() final
118  {
119  }
120 
121 private:
123 
124  InternalForwarderTransport* m_forwarder = nullptr;
125  signal::ScopedConnection m_fwTransportStateConn;
126 };
127 
128 } // namespace face
129 } // namespace nfd
130 
131 #endif // NFD_DAEMON_FACE_INTERNAL_TRANSPORT_HPP
Implements a client-side transport that can be paired with an InternalForwarderTransport.
Represents a TLV element of the NDN packet format.
Definition: block.hpp:44
Abstracts a transport that can be paired with another.
void close() final
Close the connection.
Implements a forwarder-side transport that can be paired with another transport.
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
void setPeer(InternalTransportBase *peer)
Disconnects a Connection automatically upon destruction.
#define NFD_LOG_MEMBER_DECL()
Definition: logger.hpp:32
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 resume() final
Resume the transport.
void pause() final
Pause the transport, canceling all pending operations.
virtual void receivePacket(const Block &packet)=0
The lower half of a Face.
Definition: transport.hpp:108
virtual ~InternalTransportBase()=default