stage.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2022, 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_STAGE_HPP
27 #define NFD_TOOLS_NDN_AUTOCONFIG_STAGE_HPP
28 
29 #include <ndn-cxx/net/face-uri.hpp>
30 #include <ndn-cxx/util/signal.hpp>
31 
32 #include <iostream>
33 
34 namespace ndn::autoconfig {
35 
38 class Stage : boost::noncopyable
39 {
40 public:
41  class Error : public std::runtime_error
42  {
43  public:
44  using std::runtime_error::runtime_error;
45  };
46 
47  virtual
48  ~Stage() = default;
49 
53  virtual const std::string&
54  getName() const = 0;
55 
59  void
60  start();
61 
62 protected:
65  void
66  provideHubFaceUri(const std::string& s);
67 
68  void
69  succeed(const FaceUri& hubFaceUri);
70 
71  void
72  fail(const std::string& msg);
73 
74 private:
75  virtual void
76  doStart() = 0;
77 
78 public:
83  util::Signal<Stage, FaceUri> onSuccess;
84 
89  util::Signal<Stage, std::string> onFailure;
90 
91 private:
92  bool m_isInProgress = false;
93 };
94 
95 } // namespace ndn::autoconfig
96 
97 #endif // NFD_TOOLS_NDN_AUTOCONFIG_STAGE_HPP
A discovery stage.
Definition: stage.hpp:39
void start()
Start running this stage.
Definition: stage.cpp:31
virtual ~Stage()=default
util::Signal< Stage, FaceUri > onSuccess
Signal when a HUB FaceUri is found.
Definition: stage.hpp:83
util::Signal< Stage, std::string > onFailure
Signal when discovery fails.
Definition: stage.hpp:89
void provideHubFaceUri(const std::string &s)
Parse HUB FaceUri from string and declare success.
Definition: stage.cpp:43
virtual const std::string & getName() const =0
Get stage name.
void succeed(const FaceUri &hubFaceUri)
Definition: stage.cpp:55
void fail(const std::string &msg)
Definition: stage.cpp:63