procedure.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_TOOLS_NDN_AUTOCONFIG_PROCEDURE_HPP
27 #define NFD_TOOLS_NDN_AUTOCONFIG_PROCEDURE_HPP
28 
29 #include "stage.hpp"
30 
31 #include "core/common.hpp"
32 
33 #include <ndn-cxx/face.hpp>
34 #include <ndn-cxx/mgmt/nfd/controller.hpp>
35 #include <ndn-cxx/security/key-chain.hpp>
36 
37 namespace ndn::autoconfig {
38 
39 struct Options
40 {
41  std::string ndnFchUrl = "http://ndn-fch.named-data.net";
42 };
43 
44 class Procedure : noncopyable
45 {
46 public:
47  Procedure(Face& face, KeyChain& keyChain);
48 
49  virtual
50  ~Procedure() = default;
51 
52  void
53  initialize(const Options& options);
54 
58  void
59  runOnce();
60 
61  boost::asio::io_context&
62  getIoContext() const noexcept
63  {
64  return m_face.getIoContext();
65  }
66 
67 private:
69  makeStages(const Options& options);
70 
71  void
72  connect(const FaceUri& hubFaceUri);
73 
74  void
75  registerPrefixes(uint64_t hubFaceId, size_t index = 0);
76 
77 public:
83  signal::Signal<Procedure, bool> onComplete;
84 
86  std::vector<unique_ptr<Stage>> m_stages;
87 
88 private:
89  Face& m_face;
90  KeyChain& m_keyChain;
91  nfd::Controller m_controller;
92 };
93 
94 } // namespace ndn::autoconfig
95 
96 #endif // NFD_TOOLS_NDN_AUTOCONFIG_PROCEDURE_HPP
Procedure(Face &face, KeyChain &keyChain)
Definition: procedure.cpp:42
signal::Signal< Procedure, bool > onComplete
Signal emitted when the procedure completes.
Definition: procedure.hpp:83
void initialize(const Options &options)
Definition: procedure.cpp:50
boost::asio::io_context & getIoContext() const noexcept
Definition: procedure.hpp:62
void runOnce()
Run the HUB discovery procedure once.
Definition: procedure.cpp:77
virtual ~Procedure()=default
#define NFD_VIRTUAL_WITH_TESTS
Definition: common.hpp:39
#define NFD_PROTECTED_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:42
std::string ndnFchUrl
HTTP base URL of NDN-FCH service.
Definition: procedure.hpp:41