protocol-factory.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2022, 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 #include "protocol-factory.hpp"
27 
28 #include <boost/range/adaptor/map.hpp>
29 #include <boost/range/algorithm/copy.hpp>
30 
31 namespace nfd::face {
32 
33 ProtocolFactory::Registry&
34 ProtocolFactory::getRegistry()
35 {
36  static Registry registry;
37  return registry;
38 }
39 
40 unique_ptr<ProtocolFactory>
41 ProtocolFactory::create(const std::string& id, const CtorParams& params)
42 {
43  Registry& registry = getRegistry();
44  auto found = registry.find(id);
45  if (found == registry.end()) {
46  return nullptr;
47  }
48 
49  return found->second(params);
50 }
51 
52 std::set<std::string>
54 {
55  std::set<std::string> factoryIds;
56  boost::copy(getRegistry() | boost::adaptors::map_keys,
57  std::inserter(factoryIds, factoryIds.end()));
58  return factoryIds;
59 }
60 
62  : addFace(params.addFace)
63  , netmon(params.netmon)
64 {
65  BOOST_ASSERT(addFace != nullptr);
66  BOOST_ASSERT(netmon != nullptr);
67 }
68 
70 
71 void
74 {
75  doProcessConfig(configSection, context);
76 }
77 
78 void
79 ProtocolFactory::doProcessConfig(OptionalConfigSection,
81 {
82 }
83 
84 void
86  const FaceCreatedCallback& onCreated,
87  const FaceCreationFailedCallback& onFailure)
88 {
89  BOOST_ASSERT(!FaceUri::canCanonize(req.remoteUri.getScheme()) ||
90  req.remoteUri.isCanonical());
91  BOOST_ASSERT(!req.localUri || !FaceUri::canCanonize(req.localUri->getScheme()) ||
92  req.localUri->isCanonical());
93  doCreateFace(req, onCreated, onFailure);
94 }
95 
96 void
97 ProtocolFactory::doCreateFace(const CreateFaceRequest&,
98  const FaceCreatedCallback&,
99  const FaceCreationFailedCallback& onFailure)
100 {
101  onFailure(406, "Unsupported protocol");
102 }
103 
104 shared_ptr<Face>
106  const shared_ptr<const ndn::net::NetworkInterface>& netif)
107 {
108  BOOST_ASSERT(remote.isCanonical());
109  return doCreateNetdevBoundFace(remote, netif);
110 }
111 
112 shared_ptr<Face>
113 ProtocolFactory::doCreateNetdevBoundFace(const FaceUri&,
114  const shared_ptr<const ndn::net::NetworkInterface>&)
115 {
116  NDN_THROW(Error("This protocol factory does not support netdev-bound faces"));
117 }
118 
119 std::vector<shared_ptr<const Channel>>
121 {
122  return doGetChannels();
123 }
124 
125 std::vector<shared_ptr<const Channel>>
126 ProtocolFactory::doGetChannels() const
127 {
128  return {};
129 }
130 
131 } // namespace nfd::face
Context for processing a config section in ProtocolFactory.
Base class for all exceptions thrown by ProtocolFactory subclasses.
shared_ptr< Face > createNetdevBoundFace(const FaceUri &remote, const shared_ptr< const ndn::net::NetworkInterface > &netdev)
Create a netdev-bound face.
ProtocolFactory(const CtorParams &params)
void createFace(const CreateFaceRequest &req, const FaceCreatedCallback &onCreated, const FaceCreationFailedCallback &onFailure)
Create a unicast face.
void processConfig(OptionalConfigSection configSection, FaceSystem::ConfigContext &context)
Process face_system subsection that corresponds to this protocol factory id.
FaceCreatedCallback addFace
callback when a new face is created
static std::set< std::string > listRegistered()
Get all registered protocol factory IDs.
shared_ptr< ndn::net::NetworkMonitor > netmon
NetworkMonitor for listing available network interfaces and monitoring their changes.
std::vector< shared_ptr< const Channel > > getChannels() const
Get list of open channels (listening + non-listening)
static unique_ptr< ProtocolFactory > create(const std::string &id, const CtorParams &params)
Create a protocol factory instance.
std::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:94
std::function< void(const shared_ptr< Face > &)> FaceCreatedCallback
Prototype for the callback that is invoked when a face is created (in response to an incoming connect...
Definition: channel.hpp:90
boost::optional< const ConfigSection & > OptionalConfigSection
An optional configuration file section.
Definition: config-file.hpp:46
Encapsulates a face creation request and all its parameters.
Parameters to ProtocolFactory constructor.