tcp-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-2024, 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_TCP_TRANSPORT_HPP
27 #define NFD_DAEMON_FACE_TCP_TRANSPORT_HPP
28 
29 #include "stream-transport.hpp"
30 
31 #include <ndn-cxx/util/scheduler.hpp>
32 
33 #include <boost/asio/ip/tcp.hpp>
34 
35 namespace nfd::face {
36 
37 NFD_LOG_MEMBER_DECL_SPECIALIZED(StreamTransport<boost::asio::ip::tcp>);
38 
46 class TcpTransport NFD_FINAL_UNLESS_WITH_TESTS : public StreamTransport<boost::asio::ip::tcp>
47 {
48 public:
49  TcpTransport(boost::asio::ip::tcp::socket&& socket,
50  ndn::nfd::FacePersistency persistency,
51  ndn::nfd::FaceScope faceScope);
52 
53  ssize_t
54  getSendQueueLength() final;
55 
56 protected:
57  bool
58  canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const final;
59 
60  void
61  afterChangePersistency(ndn::nfd::FacePersistency oldPersistency) final;
62 
63  void
64  doClose() final;
65 
66  void
67  handleError(const boost::system::error_code& error) final;
68 
71  reconnect();
72 
74  handleReconnect(const boost::system::error_code& error);
75 
77  handleReconnectTimeout();
78 
83  static constexpr time::milliseconds INITIAL_RECONNECT_DELAY = 1_s;
84 
88  static constexpr time::milliseconds MAX_RECONNECT_DELAY = 5_min;
89 
93  static constexpr float RECONNECT_DELAY_MULTIPLIER = 2.0f;
94 
95 private:
96  boost::asio::ip::tcp::endpoint m_remoteEndpoint;
97 
98  // The following members are valid only when the persistency is set to permanent
99  ndn::scheduler::ScopedEventId m_reconnectEvent;
100  time::milliseconds m_nextReconnectWait;
101 };
102 
103 } // namespace nfd::face
104 
105 #endif // NFD_DAEMON_FACE_TCP_TRANSPORT_HPP
Implements a Transport for stream-based protocols.
A Transport that communicates on a connected TCP socket.
bool canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const final
Invoked by canChangePersistencyTo to perform the check.
void handleError(const boost::system::error_code &error) final
void afterChangePersistency(ndn::nfd::FacePersistency oldPersistency) final
Invoked after the persistency has been changed.
TcpTransport(boost::asio::ip::tcp::socket &&socket, ndn::nfd::FacePersistency persistency, ndn::nfd::FaceScope faceScope)
ssize_t getSendQueueLength() final
Returns the current send queue length of the transport (in octets).
void doClose() final
Performs Transport specific operations to close the transport.
#define NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:41
#define NFD_VIRTUAL_WITH_TESTS
Definition: common.hpp:39
#define NFD_FINAL_UNLESS_WITH_TESTS
Definition: common.hpp:44
#define NFD_PROTECTED_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:42
#define NFD_LOG_MEMBER_DECL_SPECIALIZED(cls)
Definition: logger.hpp:33