NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-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_TCP_TRANSPORT_HPP
27 #define NFD_DAEMON_FACE_TCP_TRANSPORT_HPP
28 
29 #include "stream-transport.hpp"
30 
31 namespace nfd {
32 namespace face {
33 
35 
43 class TcpTransport FINAL_UNLESS_WITH_TESTS : public StreamTransport<boost::asio::ip::tcp>
44 {
45 public:
46  TcpTransport(protocol::socket&& socket, ndn::nfd::FacePersistency persistency, ndn::nfd::FaceScope faceScope);
47 
48  ssize_t
49  getSendQueueLength() final;
50 
51 protected:
52  bool
53  canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const final;
54 
55  void
57 
58  void
59  doClose() final;
60 
61  void
62  handleError(const boost::system::error_code& error) final;
63 
66  reconnect();
67 
69  handleReconnect(const boost::system::error_code& error);
70 
72  handleReconnectTimeout();
73 
77  static time::milliseconds s_initialReconnectWait;
78 
81  static time::milliseconds s_maxReconnectWait;
82 
85  static float s_reconnectWaitMultiplier;
86 
87 private:
88  typename protocol::endpoint m_remoteEndpoint;
89 
92  scheduler::ScopedEventId m_reconnectEvent;
93 
96  time::milliseconds m_nextReconnectWait;
97 };
98 
99 } // namespace face
100 } // namespace nfd
101 
102 #endif // NFD_DAEMON_FACE_TCP_TRANSPORT_HPP
nfd::face::TcpTransport::getSendQueueLength
ssize_t getSendQueueLength() final
Definition: tcp-transport.cpp:61
PUBLIC_WITH_TESTS_ELSE_PRIVATE
#define PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:41
nfd::face::TcpTransport::canChangePersistencyToImpl
bool canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const final
invoked by canChangePersistencyTo to perform the check
Definition: tcp-transport.cpp:83
VIRTUAL_WITH_TESTS
#define VIRTUAL_WITH_TESTS
Definition: common.hpp:39
ndn::nfd::FacePersistency
FacePersistency
Definition: nfd-constants.hpp:45
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
nfd::face::TcpTransport::afterChangePersistency
void afterChangePersistency(ndn::nfd::FacePersistency oldPersistency) final
invoked after the persistency has been changed
Definition: tcp-transport.cpp:89
nfd::face::StreamTransport< boost::asio::ip::tcp >
stream-transport.hpp
nfd::face::TcpTransport::handleError
void handleError(const boost::system::error_code &error) final
Definition: tcp-transport.cpp:102
nfd::face::TcpTransport
A Transport that communicates on a connected TCP socket.
Definition: tcp-transport.hpp:44
PROTECTED_WITH_TESTS_ELSE_PRIVATE
#define PROTECTED_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:42
nfd::face::TcpTransport::TcpTransport
TcpTransport(protocol::socket &&socket, ndn::nfd::FacePersistency persistency, ndn::nfd::FaceScope faceScope)
Definition: tcp-transport.cpp:43
nfd::face::TcpTransport::doClose
void doClose() final
performs Transport specific operations to close the transport
Definition: tcp-transport.cpp:193
ndn::nfd::FaceScope
FaceScope
Definition: nfd-constants.hpp:34
nfd::face::NFD_LOG_MEMBER_DECL_SPECIALIZED
NFD_LOG_MEMBER_DECL_SPECIALIZED((DatagramTransport< boost::asio::ip::udp, Multicast >))
ndn::detail::ScopedCancelHandle< EventId >
FINAL_UNLESS_WITH_TESTS
#define FINAL_UNLESS_WITH_TESTS
Definition: common.hpp:44