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-2019, 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
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, const EndpointId& endpoint) final;
75 
76 private:
77  NFD_LOG_MEMBER_DECL();
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& 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
nfd::face::InternalClientTransport::pause
void pause() final
pause the transport
Definition: internal-transport.hpp:115
ndn::util::signal::ScopedConnection
Disconnects a Connection automatically upon destruction.
Definition: scoped-connection.hpp:34
ndn::nfd::LINK_TYPE_POINT_TO_POINT
@ LINK_TYPE_POINT_TO_POINT
link is point-to-point
Definition: nfd-constants.hpp:59
ndn::FaceUri
represents the underlying protocol and address used by a Face
Definition: face-uri.hpp:45
nfd::face::InternalForwarderTransport::setPeer
void setPeer(InternalTransportBase *peer)
Definition: internal-transport.hpp:60
NFD_LOG_MEMBER_DECL
#define NFD_LOG_MEMBER_DECL()
Definition: logger.hpp:32
nfd::face::InternalClientTransport
Implements a client-side transport that can be paired with an InternalForwarderTransport.
Definition: internal-transport.hpp:85
nfd::face::InternalClientTransport::resume
void resume() final
resume the transport
Definition: internal-transport.hpp:120
nfd::face::InternalForwarderTransport::receivePacket
void receivePacket(const Block &packet) final
Definition: internal-transport.cpp:49
ndn::nfd::LinkType
LinkType
Definition: nfd-constants.hpp:57
transport.hpp
nfd::face::InternalTransportBase::receivePacket
virtual void receivePacket(const Block &packet)=0
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
nfd::face::InternalTransportBase::~InternalTransportBase
virtual ~InternalTransportBase()=default
nfd::face::Transport::send
void send(const Block &packet, const EndpointId &endpoint=0)
Send a link-layer packet.
Definition: transport.cpp:94
nfd::face::InternalForwarderTransport::doClose
void doClose() final
performs Transport specific operations to close the transport
Definition: internal-transport.cpp:67
nfd::face::InternalClientTransport::close
void close() final
Close the connection.
Definition: internal-transport.hpp:110
nfd::face::InternalForwarderTransport::InternalForwarderTransport
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)
Definition: internal-transport.cpp:35
ndn::nfd::FACE_SCOPE_LOCAL
@ FACE_SCOPE_LOCAL
face is local
Definition: nfd-constants.hpp:37
ndn::Block
Represents a TLV element of NDN packet format.
Definition: block.hpp:43
nfd::face::InternalForwarderTransport
Implements a forwarder-side transport that can be paired with another transport.
Definition: internal-transport.hpp:51
nfd::face::EndpointId
uint64_t EndpointId
Identifies a remote endpoint on the link.
Definition: face-common.hpp:65
ndn::nfd::FaceScope
FaceScope
Definition: nfd-constants.hpp:34
nfd::face::Transport
The lower half of a Face.
Definition: transport.hpp:109
nfd::face::InternalTransportBase
Abstracts a transport that can be paired with another.
Definition: internal-transport.hpp:39
ndn
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-strategy-choice-helper.hpp:34