NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
nfd.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_NFD_HPP
27 #define NFD_DAEMON_NFD_HPP
28 
29 #include "common/config-file.hpp"
30 
31 #include <ndn-cxx/face.hpp>
35 
36 namespace nfd {
37 
38 class FaceTable;
39 class Forwarder;
40 
42 class ForwarderStatusManager;
43 class FaceManager;
44 class FibManager;
45 class CsManager;
47 
48 namespace face {
49 class Face;
50 class FaceSystem;
51 } // namespace face
52 
58 class Nfd : noncopyable
59 {
60 public:
64  Nfd(const std::string& configFile, ndn::KeyChain& keyChain);
65 
75  Nfd(const ConfigSection& config, ndn::KeyChain& keyChain);
76 
80  ~Nfd();
81 
87  void
88  initialize();
89 
93  void
95 
96 private:
97  explicit
98  Nfd(ndn::KeyChain& keyChain);
99 
100  void
101  configureLogging();
102 
103  void
104  initializeManagement();
105 
106  void
107  reloadConfigFileFaceSection();
108 
109 private:
110  std::string m_configFile;
111  ConfigSection m_configSection;
112 
113  unique_ptr<FaceTable> m_faceTable;
114  unique_ptr<face::FaceSystem> m_faceSystem;
115  unique_ptr<Forwarder> m_forwarder;
116 
117  ndn::KeyChain& m_keyChain;
118  shared_ptr<face::Face> m_internalFace;
119  shared_ptr<ndn::Face> m_internalClientFace;
120  unique_ptr<ndn::mgmt::Dispatcher> m_dispatcher;
121  shared_ptr<CommandAuthenticator> m_authenticator;
122  unique_ptr<ForwarderStatusManager> m_forwarderStatusManager;
123  unique_ptr<FaceManager> m_faceManager;
124  unique_ptr<FibManager> m_fibManager;
125  unique_ptr<CsManager> m_csManager;
126  unique_ptr<StrategyChoiceManager> m_strategyChoiceManager;
127 
128  shared_ptr<ndn::net::NetworkMonitor> m_netmon;
129  scheduler::ScopedEventId m_reloadConfigEvent;
130 };
131 
132 } // namespace nfd
133 
134 #endif // NFD_DAEMON_NFD_HPP
config-file.hpp
nfd::FaceManager
FaceManager
Definition: face-manager.cpp:41
nfd::Nfd::Nfd
Nfd(const std::string &configFile, ndn::KeyChain &keyChain)
Create NFD instance using an absolute or relative path to a configuration file.
Definition: nfd.cpp:58
key-chain.hpp
nfd::FibManager
FibManager
Definition: fib-manager.cpp:39
nfd::Nfd::reloadConfigFile
void reloadConfigFile()
Reload configuration file and apply updates (if any).
Definition: nfd.cpp:179
nfd::face::FaceSystem
FaceSystem
Definition: face-system.cpp:35
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::ConfigSection
boost::property_tree::ptree ConfigSection
a config file section
Definition: ndn-l3-protocol.hpp:39
Face
ndn Face
Definition: face-impl.hpp:41
nfd::FaceTable
FaceTable
Definition: face-table.cpp:37
nfd::Nfd::~Nfd
~Nfd()
Destructor.
nfd::Forwarder
Forwarder
Definition: forwarder.cpp:41
face.hpp
nfd::Nfd::initialize
void initialize()
Perform initialization of NFD instance.
Definition: nfd.cpp:76
nfd::StrategyChoiceManager
StrategyChoiceManager
Definition: strategy-choice-manager.cpp:35
network-monitor.hpp
nfd::Nfd
Class representing the NFD instance.
Definition: nfd.hpp:59
ndn::detail::ScopedCancelHandle< EventId >
nfd::CommandAuthenticator
CommandAuthenticator
Definition: command-authenticator.cpp:44