service.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2023, 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_RIB_SERVICE_HPP
27 #define NFD_DAEMON_RIB_SERVICE_HPP
28 
29 #include "common/config-file.hpp"
30 #include "mgmt/rib-manager.hpp"
31 #include "rib/fib-updater.hpp"
32 #include "rib/rib.hpp"
33 
34 #include <ndn-cxx/face.hpp>
35 #include <ndn-cxx/mgmt/dispatcher.hpp>
36 #include <ndn-cxx/mgmt/nfd/controller.hpp>
37 #include <ndn-cxx/security/key-chain.hpp>
38 #include <ndn-cxx/transport/transport.hpp>
39 #include <ndn-cxx/util/scheduler.hpp>
40 
41 namespace nfd::rib {
42 
43 class Readvertise;
44 
51 class Service : noncopyable
52 {
53 public:
61  Service(const std::string& configFile, ndn::KeyChain& keyChain);
62 
73  Service(const ConfigSection& configSection, ndn::KeyChain& keyChain);
74 
75  ~Service();
76 
82  static Service&
83  get();
84 
85  RibManager&
86  getRibManager() noexcept
87  {
88  return m_ribManager;
89  }
90 
91 private:
92  template<typename ConfigParseFunc>
93  Service(ndn::KeyChain& keyChain, shared_ptr<ndn::Transport> localNfdTransport,
94  const ConfigParseFunc& configParse);
95 
96  void
97  processConfig(const ConfigSection& section, bool isDryRun, const std::string& filename);
98 
99  void
100  checkConfig(const ConfigSection& section, const std::string& filename);
101 
102  void
103  applyConfig(const ConfigSection& section, const std::string& filename);
104 
105 private:
106  static inline Service* s_instance = nullptr;
107 
108  ndn::KeyChain& m_keyChain;
109  ndn::Face m_face;
110  ndn::nfd::Controller m_nfdController;
111 
112  Rib m_rib;
113  FibUpdater m_fibUpdater;
114  unique_ptr<Readvertise> m_readvertiseNlsr;
115  unique_ptr<Readvertise> m_readvertisePropagation;
116  ndn::mgmt::Dispatcher m_dispatcher;
117  RibManager m_ribManager;
118 };
119 
120 } // namespace nfd::rib
121 
122 #endif // NFD_DAEMON_RIB_SERVICE_HPP
Implements the RIB Management of NFD Management Protocol.
Definition: rib-manager.hpp:51
Computes FibUpdates based on updates to the RIB and sends them to NFD.
Definition: fib-updater.hpp:42
Represents the Routing Information Base.
Definition: rib.hpp:70
Initializes and executes the NFD-RIB service thread.
Definition: service.hpp:52
Service(const std::string &configFile, ndn::KeyChain &keyChain)
Create NFD-RIB service.
Definition: service.cpp:88
static Service & get()
Get a reference to the only instance of this class.
Definition: service.cpp:139
RibManager & getRibManager() noexcept
Definition: service.hpp:86
boost::property_tree::ptree ConfigSection
A configuration file section.
Definition: config-file.hpp:41