websocket-factory.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2017, 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 namespace nfd {
33 namespace face {
34 
38 {
39 public:
40  static const std::string&
41  getId();
42 
43  explicit
44  WebSocketFactory(const CtorParams& params);
45 
48  void
50  FaceSystem::ConfigContext& context) override;
51 
54  void
55  createFace(const CreateFaceParams& params,
56  const FaceCreatedCallback& onCreated,
57  const FaceCreationFailedCallback& onFailure) override;
58 
71  shared_ptr<WebSocketChannel>
72  createChannel(const websocket::Endpoint& localEndpoint);
73 
74  std::vector<shared_ptr<const Channel>>
75  getChannels() const override;
76 
77 private:
78  std::map<websocket::Endpoint, shared_ptr<WebSocketChannel>> m_channels;
79 };
80 
81 } // namespace face
82 } // namespace nfd
83 
84 #endif // NFD_DAEMON_FACE_WEBSOCKET_FACTORY_HPP
protocol factory for WebSocket
WebSocketFactory(const CtorParams &params)
context for processing a config section in ProtocolFactory
Definition: face-system.hpp:85
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
boost::optional< const ConfigSection & > OptionalConfigSection
an optional config file section
Definition: config-file.hpp:41
shared_ptr< WebSocketChannel > createChannel(const websocket::Endpoint &localEndpoint)
Create WebSocket-based channel using websocket::Endpoint.
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:44
void createFace(const CreateFaceParams &params, const FaceCreatedCallback &onCreated, const FaceCreationFailedCallback &onFailure) override
unicast face creation is not supported and will always fail
Provides support for an underlying protocol.
Parameters to ProtocolFactory constructor.
std::vector< shared_ptr< const Channel > > getChannels() const override
Parameters to ProtocolFactory::createFace.
boost::asio::ip::tcp::endpoint Endpoint
void processConfig(OptionalConfigSection configSection, FaceSystem::ConfigContext &context) override
process face_system.websocket config section
static const std::string & getId()
function< void(const shared_ptr< Face > &newFace)> FaceCreatedCallback
Prototype for the callback that is invoked when a face is created (in response to an incoming connect...
Definition: channel.hpp:35