QtTaskTree::QThreadFunction Class

static void copyFile(QPromise<void> &promise, const QString &source,
                     const QString &destination)
{
    const QFileInfo fi(source);
    if (!fi.exists()) {
        promise.future().cancel(); // The QThreadFunction finishes with DoneResult::Error
        return;
    }

    // Copy file...
}

QThreadFunction<void> task;
task.setThreadFunctionData(copyFile, "source.txt", "dest.txt");
task.start();

成员函数文档

[default] QThreadFunction::QThreadFunction(QObject *parent = nullptr)

用给定的parent 构建一个 QThreadFunction。

[override virtual] QThreadFunction::~QThreadFunction()

销毁QThreadFunction 。如果QThreadFunction 没有运行，则不执行其他操作，否则取消相关的未来，并根据自动延迟同步的情况执行以下操作：

当自动延迟同步开启时，未来程序的取消可能会在另一个线程中仍在运行的函数内部被拦截，这样它就可以尽快完成任务，而不需要完成自己的工作。

最后，在应用程序退出时，应调用QThreadFunctionBase::syncAll() 以同步所有仍可能在单独线程中运行的函数。对QThreadFunctionBase::syncAll() 的调用是阻塞的，以防某些函数仍在最终完成。

另请参阅 setAutoDelayedSync() 和syncAll()。

QFuture<ResultType> QThreadFunction::future() const

返回QFuture<ResultType> 与在单独线程中执行的函数相关联。

QFutureWatcher<ResultType> *QThreadFunction::futureWatcher()

返回与在单独线程中执行的函数相关联的QFutureWatcher<ResultType> 指针。返回的观察者的生命周期与QThreadFunction 实例绑定。

如果需要对未来的执行进行更多控制，例如连接到返回的观察者的进度信号，请使用此函数。

const QFutureWatcher<ResultType> *QThreadFunction::futureWatcher() const

返回与单独线程中执行的函数相关的const 指针QFutureWatcher<ResultType> 。

bool QThreadFunction::isAutoDelayedSync() const

返回自动延迟同步是否开启。

另请参阅 syncAll() 和setAutoDelayedSync()。

bool QThreadFunction::isDone() const

返回函数是否执行完毕。

bool QThreadFunction::isResultAvailable() const

返回结果是否就绪。

另请参阅 result().

ResultType QThreadFunction::result() const

返回在独立线程中执行的函数所报告的 ResultType。

另请参阅 QFutureWatcher::result()。

ResultType QThreadFunction::resultAt(int index) const

返回在index 单独线程中执行的函数所报告的 ResultType。

另请参阅 result() 和QFutureWatcher::resultAt() 。

QList<ResultType> QThreadFunction::results() const

返回在单独线程中执行的函数所报告的 ResultType 列表。

另请参阅 result(),resultAt() 和QFuture::results().

void QThreadFunction::setAutoDelayedSync(bool on)

将自动延迟同步设置为on 。

默认情况下，自动延迟同步是开启的，这意味着运行中的QThreadFunction 对象的销毁不会阻塞等待，直到在单独线程中运行的函数完成。相反，相关的QFuture 会被取消，函数会继续运行直到结束。在独立线程中运行的函数可以通过QPromise 参数拦截取消，这样它就可以提前结束，而不会完成自己的工作。如果开启了自动延迟同步，就必须在应用程序退出时调用QThreadFunctionBase::syncAll() ，以便同步所有可能在独立线程中运行的函数。

关闭自动延迟同步时，同步会在QThreadFunction 销毁时进行，这会阻塞调用线程相当长的时间。

只有在主线程执行QThreadFunction 时，才会使用自动同步。

另请参见 syncAll() 和isAutoDelayedSync()。

template <typename Function, typename... Args> void QThreadFunction::setThreadFunctionData(Function &&function, Args &&... args)

设置当调用 start() 时，在单独线程中通过args 执行的function 。

另请参阅 QtConcurrent::run()。

void QThreadFunction::setThreadPool(QThreadPool *pool)

设置执行调用时使用的QThreadPool pool 。如果传递的pool 是nullptr ，则使用QThreadPool::globalInstance()。

另请参阅 threadPool()。

ResultType QThreadFunction::takeResult() const

获取（移动）在单独线程中执行的函数所报告的 ResultType。

另请参阅 QFuture::takeResult()。

QThreadPool *QThreadFunction::threadPool() const

返回执行调用时使用的线程池。如果返回nullptr ，则使用QThreadPool::globalInstance()。

另请参阅 setThreadPool()。