CuteHMI - CuteHMI (CuteHMI.2)
Worker.hpp
1#ifndef H_EXTENSIONS_CUTEHMI_2_INCLUDE_CUTEHMI_WORKER_HPP
2#define H_EXTENSIONS_CUTEHMI_2_INCLUDE_CUTEHMI_WORKER_HPP
3
4#include "internal/common.hpp"
5
6#include <QObject>
7#include <QEvent>
8#include <QMutex>
9#include <QWaitCondition>
10#include <QThread>
11
12#include <functional>
13
14namespace cutehmi {
15
22class CUTEHMI_API Worker:
23 public QObject
24{
25 typedef QObject Parent;
26
27 Q_OBJECT
28
29 public:
34 Worker(std::function<void()> task = nullptr);
35
41 Worker(QThread & thread);
42
43 ~Worker() override;
44
49 std::function<void()> task() const;
50
55 void setTask(std::function<void()> task);
56
63 void wait() const;
64
72 bool isReady() const;
73
80 bool isWorking() const;
81
88 void employ(QThread & thread, bool start = true);
89
96 void work();
97
98 signals:
102 void ready();
103
104 protected:
109 public QEvent
110 {
111 public:
117 static Type RegisteredType() noexcept;
118
119 public:
123 WorkEvent();
124 };
125
132 virtual void job();
133
134 bool event(QEvent * event) override;
135
136 private:
137 enum class State {
138 UNEMPLOYED,
139 EMPLOYED,
140 WORKING,
141 READY
142 };
143
144 struct Members
145 {
146 State state;
147 std::function<void()> task;
148 mutable QMutex stateMutex;
149 mutable QWaitCondition waitCondition;
150 mutable QMutex workMutex;
151
152 Members(std::function<void()> p_task):
153 state(State::UNEMPLOYED),
154 task(p_task)
155 {
156 }
157 };
158
159 MPtr<Members> m;
160};
161
162}
163
164#endif
165
166//(c)C: Copyright © 2018-2020, Michał Policht <michal@policht.pl>. All rights reserved.
167//(c)C: SPDX-License-Identifier: LGPL-3.0-or-later OR MIT
168//(c)C: This file is a part of CuteHMI.
169//(c)C: CuteHMI is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
170//(c)C: CuteHMI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
171//(c)C: You should have received a copy of the GNU Lesser General Public License along with CuteHMI. If not, see <https://www.gnu.org/licenses/>.
172//(c)C: Additionally, this file is licensed under terms of MIT license as expressed below.
173//(c)C: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
174//(c)C: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
175//(c)C: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Work event.
Definition: Worker.hpp:110
Worker.
Definition: Worker.hpp:24
void ready()
Results are ready.
Definition: constants.hpp:6