src/concurrent/qfuturesynchronizer.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtCore module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QFUTRUESYNCHRONIZER_H
  43 #define QFUTRUESYNCHRONIZER_H
  44
  45 #include <QtConcurrent/qtconcurrent_global.h>
  46
  47 #include <QtConcurrent/qfuture.h>
  48
  49 #ifndef QT_NO_CONCURRENT
  50
  51 QT_BEGIN_HEADER
  52 QT_BEGIN_NAMESPACE
  53
  54
  55 template <typename T>
  56 class QFutureSynchronizer
  57 {
  58     Q_DISABLE_COPY(QFutureSynchronizer)
  59
  60 public:
  61     QFutureSynchronizer() : m_cancelOnWait(false) { }
  62     explicit QFutureSynchronizer(const QFuture<T> &future)
  63         : m_cancelOnWait(false)
  64     { addFuture(future); }
  65     ~QFutureSynchronizer()  { waitForFinished(); }
  66
  67     void setFuture(const QFuture<T> &future)
  68     {
  69         waitForFinished();
  70         m_futures.clear();
  71         addFuture(future);
  72     }
  73
  74     void addFuture(const QFuture<T> &future)
  75     {
  76         m_futures.append(future);
  77     }
  78
  79     void waitForFinished()
  80     {
  81         if (m_cancelOnWait) {
  82             for (int i = 0; i < m_futures.count(); ++i) {
  83                  m_futures[i].cancel();
  84             }
  85         }
  86
  87         for (int i = 0; i < m_futures.count(); ++i) {
  88              m_futures[i].waitForFinished();
  89          }
  90     }
  91
  92     void clearFutures()
  93     {
  94         m_futures.clear();
  95     }
  96
  97     QList<QFuture<T> > futures() const
  98     {
  99         return m_futures;
 100     }
 101
 102     void setCancelOnWait(bool enabled)
 103     {
 104         m_cancelOnWait = enabled;
 105     }
 106
 107     bool cancelOnWait() const
 108     {
 109         return m_cancelOnWait;
 110     }
 111
 112 protected:
 113     QList<QFuture<T> > m_futures;
 114     bool m_cancelOnWait;
 115 };
 116
 117 QT_END_NAMESPACE
 118 QT_END_HEADER
 119
 120 #endif // QT_NO_CONCURRENT
 121
 122 #endif // QFUTRUESYNCHRONIZER_H