QFuture 类

template <typename T> class QFuture

QFuture 类表示异步计算的结果。 更多...

头: #include <QFuture>
qmake: QT += core
Since: Qt 4.4

该类在 Qt 4.4 引入。

注意: 此类的所有函数 thread-safe 除以下外:

公共类型

class const_iterator
typedef ConstIterator

公共函数

QFuture (const QFuture<T> & other )
QFuture ()
QFuture<T> & operator= (const QFuture<T> & other )
~QFuture ()
QFuture::const_iterator begin () const
void cancel ()
QFuture::const_iterator constBegin () const
QFuture::const_iterator constEnd () const
QFuture::const_iterator end () const
bool isCanceled () const
bool isFinished () const
bool isPaused () const
bool isResultReadyAt (int index ) const
bool isRunning () const
bool isStarted () const
void pause ()
int progressMaximum () const
int progressMinimum () const
QString progressText () const
int progressValue () const
T result () const
T resultAt (int index ) const
int resultCount () const
QList<T> 结果 () const
void resume ()
void setPaused (bool paused )
void togglePaused ()
void waitForFinished ()
T operator T () const
bool operator!= (const QFuture<T> & other ) const
bool operator== (const QFuture<T> & other ) const

详细描述

要开始计算,请使用某一 API 在 Qt Concurrent 框架。

QFuture allows threads to be synchronized against one or more results which will be ready at a later point in time. The result can be of any type that has a default constructor and a copy constructor. If a result is not available at the time of calling the result (), resultAt (),或 结果 () functions, QFuture will wait until the result becomes available. You can use the isResultReadyAt () function to determine if a result is ready or not. For QFuture objects that report more than one result, the resultCount () function returns the number of continuous results. This means that it is always safe to iterate through the results from 0 to resultCount ().

QFuture 提供 Java 风格迭代器 ( QFutureIterator ) 和 STL 样式迭代器 ( QFuture::const_iterator ). Using these iterators is another way to access results in the future.

QFuture also offers ways to interact with a running computation. For instance, the computation can be canceled with the cancel () function. To pause the computation, use the setPaused () function or one of the pause (), resume (),或 togglePaused () convenience functions. Be aware that not all running asynchronous computations can be canceled or paused. For example, the future returned by QtConcurrent::run () cannot be canceled; but the future returned by QtConcurrent::mappedReduced () can.

Progress information is provided by the progressValue (), progressMinimum (), progressMaximum (),和 progressText () 函数。 waitForFinished () function causes the calling thread to block and wait for the computation to finish, ensuring that all results are available.

The state of the computation represented by a QFuture can be queried using the isCanceled (), isStarted (), isFinished (), isRunning (),或 isPaused () 函数。

QFuture is a lightweight reference counted class that can be passed by value.

QFuture<void> is specialized to not contain any of the result fetching functions. Any QFuture<T> can be assigned or copied into a QFuture<void> as well. This is useful if only status or progress information is needed - not the actual result data.

To interact with running tasks using signals and slots, use QFutureWatcher .

注意: Some APIs (see QtConcurrent::run () allow scheduling the computation to a specific thread pool. However, QFuture implements a work-stealing algorithm to prevent deadlocks and optimize thread usage. As a result, computations can be executed directly in the thread which requests the QFuture's result.

另请参阅 QFutureWatcher and Qt Concurrent .

成员类型文档编制

typedef QFuture:: ConstIterator

Qt 样式同义词 QFuture::const_iterator .

成员函数文档编制

QFuture:: QFuture (const QFuture < T > & other )

构造副本为 other .

另请参阅 operator= ().

QFuture:: QFuture ()

构建空的被取消 Future。

QFuture < T > &QFuture:: operator= (const QFuture < T > & other )

赋值 other to this future and returns a reference to this future.

QFuture:: ~QFuture ()

销毁 Future。

Note that this neither waits nor cancels the asynchronous computation. Use waitForFinished () 或 QFutureSynchronizer when you need to ensure that the computation is completed before the future is destroyed.

QFuture::const_iterator QFuture:: begin () const

返回常量 STL 样式迭代器 指向 Future 的第一个结果。

另请参阅 constBegin () 和 end ().

void QFuture:: cancel ()

Cancels the asynchronous computation represented by this future. Note that the cancellation is asynchronous. Use waitForFinished () after calling cancel() when you need synchronous cancellation.

Results currently available may still be accessed on a canceled future, but new results will not become available after calling this function. Any QFutureWatcher object that is watching this future will not deliver progress and result ready signals on a canceled future.

Be aware that not all running asynchronous computations can be canceled. For example, the future returned by QtConcurrent::run () cannot be canceled; but the future returned by QtConcurrent::mappedReduced () can.

QFuture::const_iterator QFuture:: constBegin () const

返回常量 STL 样式迭代器 指向 Future 的第一个结果。

另请参阅 begin () 和 constEnd ().

QFuture::const_iterator QFuture:: constEnd () const

返回常量 STL 样式迭代器 pointing to the imaginary result after the last result in the future.

另请参阅 constBegin () 和 end ().

QFuture::const_iterator QFuture:: end () const

返回常量 STL 样式迭代器 pointing to the imaginary result after the last result in the future.

另请参阅 begin () 和 constEnd ().

bool QFuture:: isCanceled () const

返回 true if the asynchronous computation has been canceled with the cancel () function; otherwise returns false .

Be aware that the computation may still be running even though this function returns true 。见 cancel () 了解更多细节。

bool QFuture:: isFinished () const

返回 true if the asynchronous computation represented by this future has finished; otherwise returns false .

bool QFuture:: isPaused () const

返回 true if the asynchronous computation has been paused with the pause () function; otherwise returns false .

Be aware that the computation may still be running even though this function returns true 。见 setPaused () 了解更多细节。

另请参阅 setPaused () 和 togglePaused ().

bool QFuture:: isResultReadyAt ( int index ) const

返回 true if the result at index is immediately available; otherwise returns false .

另请参阅 resultAt () 和 resultCount ().

bool QFuture:: isRunning () const

返回 true if the asynchronous computation represented by this future is currently running; otherwise returns false .

bool QFuture:: isStarted () const

返回 true if the asynchronous computation represented by this future has been started; otherwise returns false .

void QFuture:: pause ()

Pauses the asynchronous computation represented by this future. This is a convenience method that simply calls setPaused (true)。

另请参阅 resume ().

int QFuture:: progressMaximum () const

返回最大 progressValue ().

另请参阅 progressValue () 和 progressMinimum ().

int QFuture:: progressMinimum () const

返回最小 progressValue ().

另请参阅 progressValue () 和 progressMaximum ().

QString QFuture:: progressText () const

Returns the (optional) textual representation of the progress as reported by the asynchronous computation.

Be aware that not all computations provide a textual representation of the progress, and as such, this function may return an empty string.

int QFuture:: progressValue () const

返回当前进度值,位于 progressMinimum () 和 progressMaximum ().

另请参阅 progressMinimum () 和 progressMaximum ().

T QFuture:: result () const

Returns the first result in the future. If the result is not immediately available, this function will block and wait for the result to become available. This is a convenience method for calling resultAt (0).

另请参阅 resultAt () 和 结果 ().

T QFuture:: resultAt ( int index ) const

Returns the result at index in the future. If the result is not immediately available, this function will block and wait for the result to become available.

另请参阅 result (), 结果 (),和 resultCount ().

int QFuture:: resultCount () const

Returns the number of continuous results available in this future. The real number of results stored might be different from this value, due to gaps in the result set. It is always safe to iterate through the results from 0 to resultCount().

另请参阅 result (), resultAt (),和 结果 ().

QList < T > QFuture:: 结果 () const

Returns all results from the future. If the results are not immediately available, this function will block and wait for them to become available.

另请参阅 result (), resultAt (),和 resultCount ().

void QFuture:: resume ()

Resumes the asynchronous computation represented by this future. This is a convenience method that simply calls setPaused (false).

另请参阅 pause ().

void QFuture:: setPaused ( bool paused )

paused is true, this function pauses the asynchronous computation represented by the future. If the computation is already paused, this function does nothing. Any QFutureWatcher object that is watching this future will stop delivering progress and result ready signals while the future is paused. Signal delivery will continue once the future is resumed.

paused is false, this function resumes the asynchronous computation. If the computation was not previously paused, this function does nothing.

Be aware that not all computations can be paused. For example, the future returned by QtConcurrent::run () cannot be paused; but the future returned by QtConcurrent::mappedReduced () can.

另请参阅 isPaused (), pause (), resume (),和 togglePaused ().

void QFuture:: togglePaused ()

Toggles the paused state of the asynchronous computation. In other words, if the computation is currently paused, calling this function resumes it; if the computation is running, it is paused. This is a convenience method for calling setPaused (! isPaused ()).

另请参阅 setPaused (), pause (),和 resume ().

void QFuture:: waitForFinished ()

Waits for the asynchronous computation to finish (including cancel ()ed computations).

T QFuture:: operator T () const

Returns the first result in the future. If the result is not immediately available, this function will block and wait for the result to become available. This is a convenience method for calling result () 或 resultAt (0).

另请参阅 result (), resultAt (),和 结果 ().

bool QFuture:: operator!= (const QFuture < T > & other ) const

返回 true if other is not a copy of this future; otherwise returns false.

bool QFuture:: operator== (const QFuture < T > & other ) const

返回 true if other 是此未来的副本;否则返回 false .