ledger-core
ProgressNotifier.h
1 /*
2  *
3  * ProgressNotifier
4  * ledger-core
5  *
6  * Created by Pierre Pollastri on 26/05/2017.
7  *
8  * The MIT License (MIT)
9  *
10  * Copyright (c) 2016 Ledger
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a copy
13  * of this software and associated documentation files (the "Software"), to deal
14  * in the Software without restriction, including without limitation the rights
15  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16  * copies of the Software, and to permit persons to whom the Software is
17  * furnished to do so, subject to the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be included in all
20  * copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28  * SOFTWARE.
29  *
30  */
31 #ifndef LEDGER_CORE_PROGRESSNOTIFIER_H
32 #define LEDGER_CORE_PROGRESSNOTIFIER_H
33 
34 #include <api/ExecutionContext.hpp>
35 #include <functional>
36 #include <utils/Option.hpp>
37 #include <utils/Exception.hpp>
38 #include <list>
39 #include <async/Future.hpp>
40 #include <async/Promise.hpp>
41 #include <mutex>
42 
43 namespace ledger {
44  namespace core {
45 
46  using ProgressHandler = std::function<void (const std::string&, double)>;
47 
48  template <typename T>
50  public:
52 
53  }
54 
55  ProgressNotifier(const ProgressNotifier& notifier) = delete;
56 
57  void setProgress(const std::string& step, double progress) {
58  std::lock_guard<std::mutex> lock(_mutex);
59  _lastStep = step;
60  for (auto& handler : _handlers) {
61  auto callback = handler.second;
62  Future<Unit>::async(handler.first, [step, progress, callback] () {
63  callback(step, std::max(progress, 1.0));
64  return unit;
65  });
66  }
67  };
68 
69  void success(const T& result) {
70  setProgress(_lastStep, 1.0);
71  std::lock_guard<std::mutex> lock(_mutex);
72  _promise.success(result);
73  }
74 
75  void failure(const Exception& exception) {
76  std::lock_guard<std::mutex> lock(_mutex);
77  _promise.failure(exception);
78  }
79 
80  void onProgress(const std::shared_ptr<api::ExecutionContext>& context, const ProgressHandler& handler) const {
81  std::lock_guard<std::mutex> lock(_mutex);
82  _handlers.push_back(std::make_pair(context, handler));
83  }
84 
85  Future<T> getFuture() const {
86  return _promise.getFuture();
87  }
88  private:
89  mutable std::list<std::pair<std::shared_ptr<api::ExecutionContext>, ProgressHandler>> _handlers;
90  Promise<T> _promise;
91  std::string _lastStep;
92  std::mutex _mutex;
93  };
94  }
95 }
96 
97 
98 #endif //LEDGER_CORE_PROGRESSNOTIFIER_H
Definition: Deffered.hpp:49
Definition: Deffered.hpp:52
Definition: Account.cpp:8
Definition: ProgressNotifier.h:49
Definition: Exception.hpp:45