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-2017, 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 "core/common.hpp"
30 
31 #include <ndn-cxx/net/face-uri.hpp>
32 #include <ndn-cxx/util/signal.hpp>
33 
34 #include <iostream>
35 
36 namespace ndn {
37 namespace tools {
38 namespace autoconfig {
39 
42 class Stage : boost::noncopyable
43 {
44 public:
45  class Error : public std::runtime_error
46  {
47  public:
48  explicit
49  Error(const std::string& what)
50  : std::runtime_error(what)
51  {
52  }
53  };
54 
55  virtual ~Stage() = default;
56 
60  virtual const std::string&
61  getName() const = 0;
62 
66  void
67  start();
68 
69 protected:
72  void
73  provideHubFaceUri(const std::string& s);
74 
75  void
76  succeed(const FaceUri& hubFaceUri);
77 
78  void
79  fail(const std::string& msg);
80 
81 private:
82  virtual void
83  doStart() = 0;
84 
85 public:
90  util::Signal<Stage, FaceUri> onSuccess;
91 
96  util::Signal<Stage, std::string> onFailure;
97 
98 private:
99  bool m_isInProgress = false;
100 };
101 
102 } // namespace autoconfig
103 } // namespace tools
104 } // namespace ndn
105 
106 #endif // NFD_TOOLS_NDN_AUTOCONFIG_STAGE_HPP
Copyright (c) 2014-2017, Regents of the University of California, Arizona Board of Regents...
a discovery stage
Definition: stage.hpp:42
STL namespace.
Error(const std::string &what)
Definition: stage.hpp:49
void fail(const std::string &msg)
Definition: stage.cpp:65
util::Signal< Stage, FaceUri > onSuccess
signal when a HUB FaceUri is found
Definition: stage.hpp:90
void start()
start running this stage
Definition: stage.cpp:33
util::Signal< Stage, std::string > onFailure
signal when discovery fails
Definition: stage.hpp:96
virtual const std::string & getName() const =0
get stage name
void succeed(const FaceUri &hubFaceUri)
Definition: stage.cpp:57
void provideHubFaceUri(const std::string &s)
parse HUB FaceUri from string and declare success
Definition: stage.cpp:45