tcp-channel.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_CHANNEL_HPP
27 #define NFD_DAEMON_FACE_TCP_CHANNEL_HPP
28 
29 #include "channel.hpp"
30 
31 namespace nfd {
32 
33 namespace tcp {
34 typedef boost::asio::ip::tcp::endpoint Endpoint;
35 } // namespace tcp
36 
37 namespace face {
38 
39 using DetermineFaceScopeFromAddress = std::function<ndn::nfd::FaceScope(const boost::asio::ip::address& local,
40  const boost::asio::ip::address& remote)>;
41 
49 class TcpChannel : public Channel
50 {
51 public:
58  TcpChannel(const tcp::Endpoint& localEndpoint, bool wantCongestionMarking,
59  DetermineFaceScopeFromAddress determineFaceScope);
60 
61  bool
62  isListening() const override
63  {
64  return m_acceptor.is_open();
65  }
66 
67  size_t
68  size() const override
69  {
70  return m_channelFaces.size();
71  }
72 
82  void
83  listen(const FaceCreatedCallback& onFaceCreated,
84  const FaceCreationFailedCallback& onAcceptFailed,
85  int backlog = boost::asio::ip::tcp::acceptor::max_connections);
86 
90  void
91  connect(const tcp::Endpoint& remoteEndpoint,
92  const FaceParams& params,
93  const FaceCreatedCallback& onFaceCreated,
94  const FaceCreationFailedCallback& onConnectFailed,
95  time::nanoseconds timeout = 8_s);
96 
97 private:
98  void
99  createFace(boost::asio::ip::tcp::socket&& socket,
100  const FaceParams& params,
101  const FaceCreatedCallback& onFaceCreated);
102 
103  void
104  accept(const FaceCreatedCallback& onFaceCreated,
105  const FaceCreationFailedCallback& onAcceptFailed);
106 
107  void
108  handleAccept(const boost::system::error_code& error,
109  const FaceCreatedCallback& onFaceCreated,
110  const FaceCreationFailedCallback& onAcceptFailed);
111 
112  void
113  handleConnect(const boost::system::error_code& error,
114  const tcp::Endpoint& remoteEndpoint,
115  const shared_ptr<boost::asio::ip::tcp::socket>& socket,
116  const FaceParams& params,
117  const scheduler::EventId& connectTimeoutEvent,
118  const FaceCreatedCallback& onFaceCreated,
119  const FaceCreationFailedCallback& onConnectFailed);
120 
121  void
122  handleConnectTimeout(const tcp::Endpoint& remoteEndpoint,
123  const shared_ptr<boost::asio::ip::tcp::socket>& socket,
124  const FaceCreationFailedCallback& onConnectFailed);
125 
126 private:
127  const tcp::Endpoint m_localEndpoint;
128  boost::asio::ip::tcp::acceptor m_acceptor;
129  boost::asio::ip::tcp::socket m_socket;
130  std::map<tcp::Endpoint, shared_ptr<Face>> m_channelFaces;
131  bool m_wantCongestionMarking;
132  DetermineFaceScopeFromAddress m_determineFaceScope;
133 };
134 
135 } // namespace face
136 } // namespace nfd
137 
138 #endif // NFD_DAEMON_FACE_TCP_CHANNEL_HPP
Class implementing TCP-based channel to create faces.
Definition: tcp-channel.hpp:49
std::function< ndn::nfd::FaceScope(const boost::asio::ip::address &local, const boost::asio::ip::address &remote)> DetermineFaceScopeFromAddress
Definition: tcp-channel.hpp:40
std::function< void(uint32_t status, const std::string &reason)> FaceCreationFailedCallback
Prototype for the callback that is invoked when a face fails to be created.
Definition: channel.hpp:78
Parameters used to set Transport properties or LinkService options on a newly created face...
Definition: face-common.hpp:78
bool isListening() const override
Returns whether the channel is listening.
Definition: tcp-channel.hpp:62
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
boost::asio::ip::tcp::endpoint Endpoint
Definition: tcp-channel.hpp:34
size_t size() const override
Returns the number of faces in the channel.
Definition: tcp-channel.hpp:68
Represents a channel that listens on a local endpoint.
Definition: channel.hpp:41
std::function< void(const shared_ptr< Face > &)> FaceCreatedCallback
Prototype for the callback that is invoked when a face is created (in response to an incoming connect...
Definition: channel.hpp:74