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();

メンバ関数のドキュメント

[implicit] 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

別のスレッドで実行された関数に関連付けられたQFutureWatcher<ResultType> へのconst ポインタを返します。

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()も参照してください 。