diff options
| author | Lars Knoll <lars.knoll@nokia.com> | 2012-02-03 14:17:26 +0100 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-02-05 17:49:16 +0100 |
| commit | 96501b0a18f4f70048403dccc4cb42dd71db8f9d (patch) | |
| tree | ec4b95139854d1116ad75467c3c08df39fafeb27 /src/corelib/concurrent/qfuturesynchronizer.cpp | |
| parent | c8156cab81690526adffa22214657fc1c6563b8b (diff) | |
Move QtConcurrent into its own module
Task-number: QTBUG-20892
Change-Id: I614500aafb6428915509983608bbb0ade4e4f016
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src/corelib/concurrent/qfuturesynchronizer.cpp')
| -rw-r--r-- | src/corelib/concurrent/qfuturesynchronizer.cpp | 156 |
1 files changed, 0 insertions, 156 deletions
diff --git a/src/corelib/concurrent/qfuturesynchronizer.cpp b/src/corelib/concurrent/qfuturesynchronizer.cpp deleted file mode 100644 index 34b00daf4fe..00000000000 --- a/src/corelib/concurrent/qfuturesynchronizer.cpp +++ /dev/null @@ -1,156 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/ -** -** This file is part of the QtCore module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** GNU Lesser General Public License Usage -** This file may be used under the terms of the GNU Lesser General Public -** License version 2.1 as published by the Free Software Foundation and -** appearing in the file LICENSE.LGPL included in the packaging of this -** file. Please review the following information to ensure the GNU Lesser -** General Public License version 2.1 requirements will be met: -** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU General -** Public License version 3.0 as published by the Free Software Foundation -** and appearing in the file LICENSE.GPL included in the packaging of this -** file. Please review the following information to ensure the GNU General -** Public License version 3.0 requirements will be met: -** http://www.gnu.org/copyleft/gpl.html. -** -** Other Usage -** Alternatively, this file may be used in accordance with the terms and -** conditions contained in a signed written agreement between you and Nokia. -** -** -** -** -** -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! \class QFutureSynchronizer - \since 4.4 - - \brief The QFutureSynchronizer class is a convenience class that simplifies - QFuture synchronization. - - \ingroup thread - - QFutureSynchronizer is a template class that simplifies synchronization of - one or more QFuture objects. Futures are added using the addFuture() or - setFuture() functions. The futures() function returns a list of futures. - Use clearFutures() to remove all futures from the QFutureSynchronizer. - - The waitForFinished() function waits for all futures to finish. - The destructor of QFutureSynchronizer calls waitForFinished(), providing - an easy way to ensure that all futures have finished before returning from - a function: - - \snippet doc/src/snippets/code/src_corelib_concurrent_qfuturesynchronizer.cpp 0 - - The behavior of waitForFinished() can be changed using the - setCancelOnWait() function. Calling setCancelOnWait(true) will cause - waitForFinished() to cancel all futures before waiting for them to finish. - You can query the status of the cancel-on-wait feature using the - cancelOnWait() function. - - \sa QFuture, QFutureWatcher, {Concurrent Programming}{Qt Concurrent} -*/ - -/*! - \fn QFutureSynchronizer::QFutureSynchronizer() - - Constructs a QFutureSynchronizer. -*/ - -/*! - \fn QFutureSynchronizer::QFutureSynchronizer(const QFuture<T> &future) - - Constructs a QFutureSynchronizer and begins watching \a future by calling - addFuture(). - - \sa addFuture() -*/ - -/*! - \fn QFutureSynchronizer::~QFutureSynchronizer() - - Calls waitForFinished() function to ensure that all futures have finished - before destroying this QFutureSynchronizer. - - \sa waitForFinished() -*/ - -/*! - \fn void QFutureSynchronizer::setFuture(const QFuture<T> &future) - - Sets \a future to be the only future managed by this QFutureSynchronizer. - This is a convenience function that calls waitForFinished(), - then clearFutures(), and finally passes \a future to addFuture(). - - \sa addFuture(), waitForFinished(), clearFutures() -*/ - -/*! - \fn void QFutureSynchronizer::addFuture(const QFuture<T> &future) - - Adds \a future to the list of managed futures. - - \sa futures() -*/ - -/*! - \fn void QFutureSynchronizer::waitForFinished() - - Waits for all futures to finish. If cancelOnWait() returns true, each - future is canceled before waiting for them to finish. - - \sa cancelOnWait(), setCancelOnWait() -*/ - -/*! - \fn void QFutureSynchronizer::clearFutures() - - Removes all managed futures from this QFutureSynchronizer. - - \sa addFuture(), setFuture() -*/ - -/*! - \fn QList<QFuture<T> > QFutureSynchronizer::futures() const - - Returns a list of all managed futures. - - \sa addFuture(), setFuture() -*/ - -/*! - \fn void QFutureSynchronizer::setCancelOnWait(bool enabled) - - Enables or disables the cancel-on-wait feature based on the \a enabled - argument. If \a enabled is true, the waitForFinished() function will cancel - all futures before waiting for them to finish. - - \sa waitForFinished() -*/ - -/*! - \fn bool QFutureSynchronizer::cancelOnWait() const - - Returns true if the cancel-on-wait feature is enabled; otherwise returns - false. If cancel-on-wait is enabled, the waitForFinished() function will - cancel all futures before waiting for them to finish. - - \sa waitForFinished() -*/ |