blob: b241fcc3704ef5921666b2649bb760d4eeb8c1ed [file] [log] [blame]
Wentao Shang53df1632014-04-21 12:01:32 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * 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
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_WEBSOCKET_FACTORY_HPP
27#define NFD_DAEMON_FACE_WEBSOCKET_FACTORY_HPP
28
29#include "protocol-factory.hpp"
30#include "websocket-channel.hpp"
31
32
33namespace nfd {
34
35class WebSocketFactory : public ProtocolFactory
36{
37public:
38 /**
39 * \brief Exception of WebSocketFactory
40 */
41 class Error : public ProtocolFactory::Error
42 {
43 public:
44 explicit
45 Error(const std::string& what)
46 : ProtocolFactory::Error(what)
47 {
48 }
49 };
50
51 explicit
52 WebSocketFactory(const std::string& defaultPort);
53
54 /**
55 * \brief Create WebSocket-based channel using websocket::Endpoint
56 *
57 * websocket::Endpoint is really an alias for boost::asio::ip::tcp::endpoint.
58 *
59 * If this method called twice with the same endpoint, only one channel
60 * will be created. The second call will just retrieve the existing
61 * channel.
62 *
63 * \returns always a valid pointer to a WebSocketChannel object, an exception
64 * is thrown if it cannot be created.
65 *
66 * \throws WebSocketFactory::Error
67 *
68 */
69 shared_ptr<WebSocketChannel>
70 createChannel(const websocket::Endpoint& localEndpoint);
71
72 /**
73 * \brief Create WebSocket-based channel using specified ip address and port number
74 *
75 * \throws WebSocketFactory::Error
76 */
77 shared_ptr<WebSocketChannel>
78 createChannel(const std::string& localIPAddress,
79 uint16_t localPort);
80
81 // from Factory
82 virtual void
83 createFace(const FaceUri& uri,
84 const FaceCreatedCallback& onCreated,
85 const FaceConnectFailedCallback& onConnectFailed);
86
87private:
88
89 /**
90 * \brief Look up WebSocketChannel using specified local endpoint
91 *
92 * \returns shared pointer to the existing WebSocketChannel object
93 * or empty shared pointer when such channel does not exist
94 *
95 * \throws never
96 */
97 shared_ptr<WebSocketChannel>
98 findChannel(const websocket::Endpoint& localEndpoint);
99
100 typedef std::map< websocket::Endpoint, shared_ptr<WebSocketChannel> > ChannelMap;
101 ChannelMap m_channels;
102
103 std::string m_defaultPort;
104};
105
106} // namespace nfd
107
108#endif // NFD_DAEMON_FACE_WEBSOCKET_FACTORY_HPP