blob: afcc9dd8f3256cc508ab40c6ba4d94986aa5cee0 [file] [log] [blame]
Alexander Afanasyeva9034b02014-01-26 18:32:02 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -07003 * Copyright (c) 2014 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 *
10 * This file is part of NFD (Named Data Networking Forwarding Daemon).
11 * See AUTHORS.md for complete list of NFD authors and contributors.
12 *
13 * NFD is free software: you can redistribute it and/or modify it under the terms
14 * of the GNU General Public License as published by the Free Software Foundation,
15 * either version 3 of the License, or (at your option) any later version.
16 *
17 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
18 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
19 * PURPOSE. See the GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License along with
22 * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
23 **/
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080024
Alexander Afanasyev613e2a92014-04-15 13:36:58 -070025#ifndef NFD_DAEMON_FACE_TCP_FACTORY_HPP
26#define NFD_DAEMON_FACE_TCP_FACTORY_HPP
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080027
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080028#include "protocol-factory.hpp"
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080029#include "tcp-channel.hpp"
30
Alexander Afanasyev18bbf812014-01-29 01:40:23 -080031namespace nfd {
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080032
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080033class TcpFactory : public ProtocolFactory
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080034{
35public:
36 /**
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080037 * \brief Exception of TcpFactory
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080038 */
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080039 struct Error : public ProtocolFactory::Error
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080040 {
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080041 Error(const std::string& what) : ProtocolFactory::Error(what) {}
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080042 };
43
Alexander Afanasyevd6655302014-02-28 08:41:28 -080044 explicit
45 TcpFactory(const std::string& defaultPort = "6363");
46
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080047 /**
48 * \brief Create TCP-based channel using tcp::Endpoint
49 *
50 * tcp::Endpoint is really an alias for boost::asio::ip::tcp::endpoint.
51 *
52 * If this method called twice with the same endpoint, only one channel
53 * will be created. The second call will just retrieve the existing
54 * channel.
55 *
56 * \returns always a valid pointer to a TcpChannel object, an exception
57 * is thrown if it cannot be created.
58 *
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080059 * \throws TcpFactory::Error
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080060 *
61 * \see http://www.boost.org/doc/libs/1_42_0/doc/html/boost_asio/reference/ip__tcp/endpoint.html
62 * for details on ways to create tcp::Endpoint
63 */
64 shared_ptr<TcpChannel>
Alexander Afanasyevd6655302014-02-28 08:41:28 -080065 createChannel(const tcp::Endpoint& localEndpoint);
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080066
67 /**
68 * \brief Create TCP-based channel using specified host and port number
69 *
70 * This method will attempt to resolve the provided host and port numbers
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080071 * and will throw TcpFactory::Error when channel cannot be created.
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080072 *
73 * Note that this call will **BLOCK** until resolution is done or failed.
74 *
Alexander Afanasyev5f1ec252014-02-28 10:59:17 -080075 * \throws TcpFactory::Error or std::runtime_error
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080076 */
77 shared_ptr<TcpChannel>
Alexander Afanasyevd6655302014-02-28 08:41:28 -080078 createChannel(const std::string& localHost, const std::string& localPort);
79
80 // from Factory
81
82 virtual void
83 createFace(const FaceUri& uri,
84 const FaceCreatedCallback& onCreated,
85 const FaceConnectFailedCallback& onConnectFailed);
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080086
Davide Pesaventobc4dd8c2014-02-14 20:01:01 +010087private:
Steve DiBenedettoca53ac62014-03-27 19:58:40 -060088
89 void
90 prohibitEndpoint(const tcp::Endpoint& endpoint);
91
92 void
93 prohibitAllIpv4Endpoints(const uint16_t port);
94
95 void
96 prohibitAllIpv6Endpoints(const uint16_t port);
97
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080098 /**
99 * \brief Look up TcpChannel using specified local endpoint
100 *
101 * \returns shared pointer to the existing TcpChannel object
Alexander Afanasyev7329e022014-02-27 14:47:22 -0800102 * or empty shared pointer when such channel does not exist
Alexander Afanasyeva9034b02014-01-26 18:32:02 -0800103 *
104 * \throws never
105 */
106 shared_ptr<TcpChannel>
Alexander Afanasyevd6655302014-02-28 08:41:28 -0800107 findChannel(const tcp::Endpoint& localEndpoint);
108
109 void
110 continueCreateFaceAfterResolve(const tcp::Endpoint& endpoint,
111 const FaceCreatedCallback& onCreated,
112 const FaceConnectFailedCallback& onConnectFailed);
Davide Pesaventobc4dd8c2014-02-14 20:01:01 +0100113
Alexander Afanasyev8ad71ba2014-01-27 00:07:14 -0800114private:
Alexander Afanasyev7329e022014-02-27 14:47:22 -0800115 typedef std::map< tcp::Endpoint, shared_ptr<TcpChannel> > ChannelMap;
116 ChannelMap m_channels;
Alexander Afanasyevd6655302014-02-28 08:41:28 -0800117
118 std::string m_defaultPort;
Steve DiBenedettoca53ac62014-03-27 19:58:40 -0600119
120 std::set<tcp::Endpoint> m_prohibitedEndpoints;
Alexander Afanasyeva9034b02014-01-26 18:32:02 -0800121};
122
Alexander Afanasyev18bbf812014-01-29 01:40:23 -0800123} // namespace nfd
Alexander Afanasyeva9034b02014-01-26 18:32:02 -0800124
Alexander Afanasyev613e2a92014-04-15 13:36:58 -0700125#endif // NFD_DAEMON_FACE_TCP_FACTORY_HPP