protocol-factory.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2024,  Regents of the University of California,
 *                           Arizona Board of Regents,
 *                           Colorado State University,
 *                           University Pierre & Marie Curie, Sorbonne University,
 *                           Washington University in St. Louis,
 *                           Beijing Institute of Technology,
 *                           The University of Memphis.
 *
 * This file is part of NFD (Named Data Networking Forwarding Daemon).
 * See AUTHORS.md for complete list of NFD authors and contributors.
 *
 * NFD is free software: you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.  See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * NFD, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef NFD_DAEMON_FACE_PROTOCOL_FACTORY_HPP
#define NFD_DAEMON_FACE_PROTOCOL_FACTORY_HPP
 
#include "channel.hpp"
#include "face.hpp"
#include "face-system.hpp"
 
#include <boost/range/adaptor/map.hpp>
#include <boost/range/algorithm/copy.hpp>
 
#include <functional>
#include <map>
#include <set>
 
namespace nfd::face {
 
struct ProtocolFactoryCtorParams
{
  FaceCreatedCallback addFace;
  shared_ptr<ndn::net::NetworkMonitor> netmon;
};
 
class ProtocolFactory : noncopyable
{
public: // registry
  using CtorParams = ProtocolFactoryCtorParams;
 
  template<typename PF>
  static void
  registerType(const std::string& id = PF::getId())
  {
    BOOST_ASSERT(!id.empty());
    auto r = getRegistry().insert_or_assign(id, [] (auto&&... p) {
      return make_unique<PF>(std::forward<decltype(p)>(p)...);
    });
    BOOST_VERIFY(r.second);
  }
 
  static unique_ptr<ProtocolFactory>
  create(const std::string& id, const CtorParams& params);
 
  [[nodiscard]] static std::set<std::string>
  listRegistered();
 
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };
 
  explicit
  ProtocolFactory(const CtorParams& params);
 
  virtual
  ~ProtocolFactory() = 0;
 
#ifdef DOXYGEN
  static const std::string&
  getId() noexcept;
#endif
 
  const std::set<std::string>&
  getProvidedSchemes() const noexcept
  {
    return providedSchemes;
  }
 
  void
  processConfig(OptionalConfigSection configSection, FaceSystem::ConfigContext& context);
 
  struct CreateFaceRequest
  {
    FaceUri remoteUri;
    std::optional<FaceUri> localUri;
    FaceParams params;
  };
 
  void
  createFace(const CreateFaceRequest& req,
             const FaceCreatedCallback& onCreated,
             const FaceCreationFailedCallback& onFailure);
 
  shared_ptr<Face>
  createNetdevBoundFace(const FaceUri& remote,
                        const shared_ptr<const ndn::net::NetworkInterface>& netdev);
 
  std::vector<shared_ptr<const Channel>>
  getChannels() const;
 
protected:
  template<typename ChannelMap>
  static std::vector<shared_ptr<const Channel>>
  getChannelsFromMap(const ChannelMap& channelMap)
  {
    std::vector<shared_ptr<const Channel>> channels;
    boost::copy(channelMap | boost::adaptors::map_values, std::back_inserter(channels));
    return channels;
  }
 
private:
  virtual void
  doProcessConfig(OptionalConfigSection configSection, FaceSystem::ConfigContext& context);
 
  virtual void
  doCreateFace(const CreateFaceRequest& req,
               const FaceCreatedCallback& onCreated,
               const FaceCreationFailedCallback& onFailure);
 
  virtual shared_ptr<Face>
  doCreateNetdevBoundFace(const FaceUri& remote,
                          const shared_ptr<const ndn::net::NetworkInterface>& netif);
 
  virtual std::vector<shared_ptr<const Channel>>
  doGetChannels() const;
 
private: // registry
  using CreateFunc = std::function<unique_ptr<ProtocolFactory>(const CtorParams&)>;
  using Registry = std::map<std::string, CreateFunc>; // indexed by factory id
 
  static Registry&
  getRegistry();
 
protected:
  std::set<std::string> providedSchemes; 
  FaceCreatedCallback addFace; 
 
  shared_ptr<ndn::net::NetworkMonitor> netmon;
};
 
} // namespace nfd::face
 
#define NFD_REGISTER_PROTOCOL_FACTORY(PF)                      \
static class NfdAuto ## PF ## ProtocolFactoryRegistrationClass \
{                                                              \
public:                                                        \
  NfdAuto ## PF ## ProtocolFactoryRegistrationClass()          \
  {                                                            \
    ::nfd::face::ProtocolFactory::registerType<PF>();          \
  }                                                            \
} g_nfdAuto ## PF ## ProtocolFactoryRegistrationVariable
 
#endif // NFD_DAEMON_FACE_PROTOCOL_FACTORY_HPP