NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2021, 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 
37 class WebSocketFactory final : public ProtocolFactory
38 {
39 public:
40  static const std::string&
41  getId() noexcept;
42 
44 
57  shared_ptr<WebSocketChannel>
58  createChannel(const websocket::Endpoint& localEndpoint);
59 
60 private:
63  void
64  doProcessConfig(OptionalConfigSection configSection,
65  FaceSystem::ConfigContext& context) final;
66 
67  std::vector<shared_ptr<const Channel>>
68  doGetChannels() const final;
69 
70 private:
71  std::map<websocket::Endpoint, shared_ptr<WebSocketChannel>> m_channels;
72 };
73 
74 } // namespace face
75 } // namespace nfd
76 
77 #endif // NFD_DAEMON_FACE_WEBSOCKET_FACTORY_HPP
shared_ptr< WebSocketChannel > createChannel(const websocket::Endpoint &localEndpoint)
Create WebSocket-based channel using websocket::Endpoint.
ProtocolFactory(const CtorParams &params)
static const std::string & getId() noexcept
boost::optional< const ConfigSection & > OptionalConfigSection
an optional config file section
Definition: config-file.hpp:41
Protocol factory for WebSocket.
Provides support for an underlying protocol.
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
context for processing a config section in ProtocolFactory
Definition: face-system.hpp:96
boost::asio::ip::tcp::endpoint Endpoint