NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2019, 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>
40 
41 namespace nfd {
42 namespace rib {
43 
44 class Readvertise;
45 
52 class Service : noncopyable
53 {
54 public:
55  Service(const ConfigSection& configSection, ndn::Face& face, ndn::KeyChain& keyChain);
56 
60  ~Service();
61 
67  static Service&
68  get();
69 
70  RibManager&
72  {
73  return m_ribManager;
74  }
75 
76 private:
77  template<typename ConfigParseFunc>
78  Service(ndn::KeyChain& keyChain, ndn::Face& face,
79  const ConfigParseFunc& configParse);
80 
81  void
82  processConfig(const ConfigSection& section, bool isDryRun, const std::string& filename);
83 
84  void
85  checkConfig(const ConfigSection& section, const std::string& filename);
86 
87  void
88  applyConfig(const ConfigSection& section, const std::string& filename);
89 
90 private:
91  ndn::KeyChain& m_keyChain;
92  ndn::Face& m_face;
93  ndn::Scheduler m_scheduler;
94  ndn::nfd::Controller m_nfdController;
95 
96  Rib m_rib;
97  FibUpdater m_fibUpdater;
98  unique_ptr<Readvertise> m_readvertiseNlsr;
99  unique_ptr<Readvertise> m_readvertisePropagation;
100  ndn::mgmt::Dispatcher m_dispatcher;
101  RibManager m_ribManager;
102 };
103 
104 } // namespace rib
105 } // namespace nfd
106 
107 #endif // NFD_DAEMON_RIB_SERVICE_HPP
config-file.hpp
nfd::rib::Service::Service
Service(const ConfigSection &configSection, ndn::Face &face, ndn::KeyChain &keyChain)
Definition: service.cpp:58
key-chain.hpp
nfd::rib::FibUpdater
computes FibUpdates based on updates to the RIB and sends them to NFD
Definition: fib-updater.hpp:42
controller.hpp
ndn::nfd::Controller
NFD Management protocol client.
Definition: controller.hpp:52
transport.hpp
ndn::Face
Provide a communication channel with local or remote NDN forwarder.
Definition: face.hpp:90
scheduler.hpp
nfd::rib::Service::getRibManager
RibManager & getRibManager()
Definition: service.hpp:71
nfd::rib::Service
initializes and executes NFD-RIB service thread
Definition: service.hpp:53
rib.hpp
fib-updater.hpp
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
dispatcher.hpp
ndn::security::v2::KeyChain
The interface of signing key management.
Definition: key-chain.hpp:47
nfd::rib::Rib
represents the Routing Information Base
Definition: rib.hpp:60
nfd::rib::Readvertise
Readvertise
Definition: readvertise.cpp:35
nfd::rib::Service::~Service
~Service()
Destructor.
Definition: service.cpp:85
rib-manager.hpp
nfd::RibManager
Implements the RIB Management of NFD Management Protocol.
Definition: rib-manager.hpp:50
nfd::ConfigSection
boost::property_tree::ptree ConfigSection
a config file section
Definition: ndn-l3-protocol.hpp:39
face.hpp
ndn::scheduler::Scheduler
Generic time-based scheduler.
Definition: scheduler.hpp:133
ndn::mgmt::Dispatcher
represents a dispatcher on server side of NFD Management protocol
Definition: dispatcher.hpp:131
nfd::rib::Service::get
static Service & get()
Get a reference to the only instance of this class.
Definition: service.cpp:90