blob: fd57fe51b7968a9ef5bea908654be61838104194 [file] [log] [blame]
Alexander Afanasyeva9034b02014-01-26 18:32:02 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Steve DiBenedettoef04f272014-06-04 14:28:31 -06003 * 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 * The University of Memphis
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -070010 *
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/>.
Steve DiBenedettoef04f272014-06-04 14:28:31 -060024 */
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080025
Alexander Afanasyev613e2a92014-04-15 13:36:58 -070026#ifndef NFD_DAEMON_FACE_TCP_FACTORY_HPP
27#define NFD_DAEMON_FACE_TCP_FACTORY_HPP
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080028
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080029#include "protocol-factory.hpp"
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080030#include "tcp-channel.hpp"
31
Alexander Afanasyev18bbf812014-01-29 01:40:23 -080032namespace nfd {
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080033
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080034class TcpFactory : public ProtocolFactory
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080035{
36public:
37 /**
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080038 * \brief Exception of TcpFactory
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080039 */
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080040 struct Error : public ProtocolFactory::Error
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080041 {
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080042 Error(const std::string& what) : ProtocolFactory::Error(what) {}
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080043 };
44
Alexander Afanasyevd6655302014-02-28 08:41:28 -080045 explicit
46 TcpFactory(const std::string& defaultPort = "6363");
47
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080048 /**
49 * \brief Create TCP-based channel using tcp::Endpoint
50 *
51 * tcp::Endpoint is really an alias for boost::asio::ip::tcp::endpoint.
52 *
53 * If this method called twice with the same endpoint, only one channel
54 * will be created. The second call will just retrieve the existing
55 * channel.
56 *
57 * \returns always a valid pointer to a TcpChannel object, an exception
58 * is thrown if it cannot be created.
59 *
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080060 * \throws TcpFactory::Error
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080061 *
62 * \see http://www.boost.org/doc/libs/1_42_0/doc/html/boost_asio/reference/ip__tcp/endpoint.html
63 * for details on ways to create tcp::Endpoint
64 */
65 shared_ptr<TcpChannel>
Alexander Afanasyevd6655302014-02-28 08:41:28 -080066 createChannel(const tcp::Endpoint& localEndpoint);
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080067
68 /**
69 * \brief Create TCP-based channel using specified host and port number
70 *
71 * This method will attempt to resolve the provided host and port numbers
Alexander Afanasyev0eb70652014-02-27 18:35:07 -080072 * and will throw TcpFactory::Error when channel cannot be created.
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080073 *
74 * Note that this call will **BLOCK** until resolution is done or failed.
75 *
Alexander Afanasyev5f1ec252014-02-28 10:59:17 -080076 * \throws TcpFactory::Error or std::runtime_error
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080077 */
78 shared_ptr<TcpChannel>
Alexander Afanasyevd6655302014-02-28 08:41:28 -080079 createChannel(const std::string& localHost, const std::string& localPort);
80
81 // from Factory
82
83 virtual void
84 createFace(const FaceUri& uri,
85 const FaceCreatedCallback& onCreated,
86 const FaceConnectFailedCallback& onConnectFailed);
Alexander Afanasyeva9034b02014-01-26 18:32:02 -080087
Steve DiBenedettoef04f272014-06-04 14:28:31 -060088 virtual std::list<shared_ptr<const Channel> >
89 getChannels() const;
90
Davide Pesaventobc4dd8c2014-02-14 20:01:01 +010091private:
Steve DiBenedettoca53ac62014-03-27 19:58:40 -060092
93 void
94 prohibitEndpoint(const tcp::Endpoint& endpoint);
95
96 void
97 prohibitAllIpv4Endpoints(const uint16_t port);
98
99 void
100 prohibitAllIpv6Endpoints(const uint16_t port);
101
Alexander Afanasyeva9034b02014-01-26 18:32:02 -0800102 /**
103 * \brief Look up TcpChannel using specified local endpoint
104 *
105 * \returns shared pointer to the existing TcpChannel object
Alexander Afanasyev7329e022014-02-27 14:47:22 -0800106 * or empty shared pointer when such channel does not exist
Alexander Afanasyeva9034b02014-01-26 18:32:02 -0800107 *
108 * \throws never
109 */
110 shared_ptr<TcpChannel>
Alexander Afanasyevd6655302014-02-28 08:41:28 -0800111 findChannel(const tcp::Endpoint& localEndpoint);
112
113 void
114 continueCreateFaceAfterResolve(const tcp::Endpoint& endpoint,
115 const FaceCreatedCallback& onCreated,
116 const FaceConnectFailedCallback& onConnectFailed);
Davide Pesaventobc4dd8c2014-02-14 20:01:01 +0100117
Alexander Afanasyev8ad71ba2014-01-27 00:07:14 -0800118private:
Alexander Afanasyev7329e022014-02-27 14:47:22 -0800119 typedef std::map< tcp::Endpoint, shared_ptr<TcpChannel> > ChannelMap;
120 ChannelMap m_channels;
Alexander Afanasyevd6655302014-02-28 08:41:28 -0800121
122 std::string m_defaultPort;
Steve DiBenedettoca53ac62014-03-27 19:58:40 -0600123
124 std::set<tcp::Endpoint> m_prohibitedEndpoints;
Alexander Afanasyeva9034b02014-01-26 18:32:02 -0800125};
126
Alexander Afanasyev18bbf812014-01-29 01:40:23 -0800127} // namespace nfd
Alexander Afanasyeva9034b02014-01-26 18:32:02 -0800128
Alexander Afanasyev613e2a92014-04-15 13:36:58 -0700129#endif // NFD_DAEMON_FACE_TCP_FACTORY_HPP