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-2018, 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 #include "core/scheduler.hpp"
31 
32 namespace nfd {
33 namespace face {
34 
42 class TcpTransport FINAL_UNLESS_WITH_TESTS : public StreamTransport<boost::asio::ip::tcp>
43 {
44 public:
45  TcpTransport(protocol::socket&& socket, ndn::nfd::FacePersistency persistency, ndn::nfd::FaceScope faceScope);
46 
47  ssize_t
48  getSendQueueLength() final;
49 
50 protected:
51  bool
52  canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const final;
53 
54  void
56 
57  void
58  doClose() final;
59 
60  void
61  handleError(const boost::system::error_code& error) final;
62 
65  reconnect();
66 
68  handleReconnect(const boost::system::error_code& error);
69 
71  handleReconnectTimeout();
72 
76  static time::milliseconds s_initialReconnectWait;
77 
80  static time::milliseconds s_maxReconnectWait;
81 
84  static float s_reconnectWaitMultiplier;
85 
86 private:
87  typename protocol::endpoint m_remoteEndpoint;
88 
91  scheduler::ScopedEventId m_reconnectEvent;
92 
95  time::milliseconds m_nextReconnectWait;
96 };
97 
98 } // namespace face
99 } // namespace nfd
100 
101 #endif // NFD_DAEMON_FACE_TCP_TRANSPORT_HPP
#define PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:40
void afterChangePersistency(ndn::nfd::FacePersistency oldPersistency) final
invoked after the persistency has been changed
void doClose() final
performs Transport specific operations to close the transport
A Transport that communicates on a connected TCP socket.
#define VIRTUAL_WITH_TESTS
Definition: common.hpp:38
ssize_t getSendQueueLength() final
Implements Transport for stream-based protocols.
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
Cancels an event automatically upon destruction.
Definition: scheduler.hpp:60
TcpTransport(protocol::socket &&socket, ndn::nfd::FacePersistency persistency, ndn::nfd::FaceScope faceScope)
void handleError(const boost::system::error_code &error) final
bool canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const final
invoked by canChangePersistencyTo to perform the check
#define PROTECTED_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:41
#define FINAL_UNLESS_WITH_TESTS
Definition: common.hpp:42