1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtCore module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QFUTURESYNCHRONIZER_H
41#define QFUTURESYNCHRONIZER_H
42
43#include <QtCore/qfuture.h>
44
45QT_REQUIRE_CONFIG(future);
46
47QT_BEGIN_NAMESPACE
48
49
50template <typename T>
51class QFutureSynchronizer
52{
53 Q_DISABLE_COPY(QFutureSynchronizer)
54
55public:
56 QFutureSynchronizer() : m_cancelOnWait(false) { }
57 explicit QFutureSynchronizer(const QFuture<T> &future)
58 : m_cancelOnWait(false)
59 { addFuture(future); }
60 ~QFutureSynchronizer() { waitForFinished(); }
61
62 void setFuture(const QFuture<T> &future)
63 {
64 waitForFinished();
65 m_futures.clear();
66 addFuture(future);
67 }
68
69 void addFuture(const QFuture<T> &future)
70 {
71 m_futures.append(future);
72 }
73
74 void waitForFinished()
75 {
76 if (m_cancelOnWait) {
77 for (int i = 0; i < m_futures.count(); ++i) {
78 m_futures[i].cancel();
79 }
80 }
81
82 for (int i = 0; i < m_futures.count(); ++i) {
83 m_futures[i].waitForFinished();
84 }
85 }
86
87 void clearFutures()
88 {
89 m_futures.clear();
90 }
91
92 QList<QFuture<T> > futures() const
93 {
94 return m_futures;
95 }
96
97 void setCancelOnWait(bool enabled)
98 {
99 m_cancelOnWait = enabled;
100 }
101
102 bool cancelOnWait() const
103 {
104 return m_cancelOnWait;
105 }
106
107protected:
108 QList<QFuture<T>> m_futures;
109 bool m_cancelOnWait;
110};
111
112QT_END_NAMESPACE
113
114#endif // QFUTURESYNCHRONIZER_H
115