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

Dokumentation der Mitgliedsfunktionen

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

Konstruiert eine QThreadFunction mit einer gegebenen parent.

[override virtual] QThreadFunction::~QThreadFunction()

Zerstört die QThreadFunction. Wenn die QThreadFunction nicht läuft, werden keine weiteren Aktionen durchgeführt, andernfalls wird der zugehörige Future abgebrochen, und je nach automatischer verzögerter Synchronisation werden die folgenden Aktionen durchgeführt:

Wenn die automatische verzögerte Synchronisierung eingeschaltet ist, kann die Stornierung des Futures innerhalb der noch laufenden Funktion in einem separaten Thread abgefangen werden, so dass sie so schnell wie möglich beendet werden kann, ohne ihre Aufgabe zu beenden.

Schließlich sollte beim Beenden der Anwendung QThreadFunctionBase::syncAll() aufgerufen werden, um alle Funktionen zu synchronisieren, die möglicherweise noch in separaten Threads laufen. Der Aufruf von QThreadFunctionBase::syncAll() ist blockierend, falls einige Funktionen noch in der Endphase sind.

Siehe auch setAutoDelayedSync() und syncAll().

QFuture<ResultType> QThreadFunction::future() const

Gibt die QFuture<ResultType> zurück, die mit der in einem separaten Thread ausgeführten Funktion verbunden ist.

QFutureWatcher<ResultType> *QThreadFunction::futureWatcher()

Gibt den Zeiger auf den QFutureWatcher<ResultType> zurück, der mit der in einem separaten Thread ausgeführten Funktion verbunden ist. Die Lebensdauer des zurückgegebenen Watchers ist an die Instanz QThreadFunction gebunden.

Verwenden Sie diese Funktion, wenn Sie mehr Kontrolle über die zukünftige Ausführung benötigen, z. B. um eine Verbindung zu den Fortschrittssignalen des zurückgegebenen Watchers herzustellen.

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

Gibt den Zeiger const auf die QFutureWatcher<ResultType> zurück, die mit der in einem separaten Thread ausgeführten Funktion verbunden ist.

bool QThreadFunction::isAutoDelayedSync() const

Gibt zurück, ob die automatische verzögerte Synchronisierung eingeschaltet ist.

Siehe auch syncAll() und setAutoDelayedSync().

bool QThreadFunction::isDone() const

Gibt zurück, ob die Ausführung der Funktion beendet ist.

bool QThreadFunction::isResultAvailable() const

Gibt zurück, ob das Ergebnis fertig ist.

Siehe auch result().

ResultType QThreadFunction::result() const

Gibt den Ergebnistyp zurück, der von der in einem separaten Thread ausgeführten Funktion gemeldet wurde.

Siehe auch QFutureWatcher::result().

ResultType QThreadFunction::resultAt(int index) const

Gibt den Ergebnistyp zurück, der von der Funktion gemeldet wurde, die in einem separaten Thread unter index ausgeführt wird.

Siehe auch result() und QFutureWatcher::resultAt().

QList<ResultType> QThreadFunction::results() const

Gibt die Liste der ResultType zurück, die von der in einem separaten Thread ausgeführten Funktion gemeldet wurden.

Siehe auch result(), resultAt(), und QFuture::results().

void QThreadFunction::setAutoDelayedSync(bool on)

Setzt die automatische verzögerte Synchronisierung auf on.

Standardmäßig ist die automatische verzögerte Synchronisierung eingeschaltet, was bedeutet, dass die Zerstörung des laufenden QThreadFunction Objekts nicht blockiert wird, bis die in einem separaten Thread laufende Funktion beendet ist. Stattdessen wird die zugehörige QFuture abgebrochen, und die Funktion wird weiter ausgeführt, bis sie beendet ist. Der Abbruch kann von der Funktion, die in einem separaten Thread läuft, über das Argument QPromise abgefangen werden, so dass sie vorzeitig beendet werden kann, ohne ihre Aufgabe zu erfüllen. Wenn die automatische verzögerte Synchronisierung eingeschaltet ist, muss beim Beenden der Anwendung QThreadFunctionBase::syncAll() aufgerufen werden, um alle möglicherweise laufenden Funktionen in separaten Threads zu synchronisieren.

Wenn die automatische verzögerte Synchronisierung ausgeschaltet ist, erfolgt die Synchronisierung bei der Zerstörung von QThreadFunction, was den aufrufenden Thread für eine beträchtliche Zeitspanne blockieren kann.

Die automatische Synchronisation wird nur verwendet, wenn QThreadFunction vom Haupt-Thread aus ausgeführt wurde.

Siehe auch syncAll() und isAutoDelayedSync().

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

Legt die function fest, die mit der übergebenen args in einem separaten Thread ausgeführt werden soll, wenn start() aufgerufen wird.

Siehe auch QtConcurrent::run().

void QThreadFunction::setThreadPool(QThreadPool *pool)

Legt den QThreadPool pool fest, der bei der Ausführung des Aufrufs verwendet werden soll. Wenn die übergebene pool nullptr ist, wird QThreadPool::globalInstance() verwendet.

Siehe auch threadPool().

ResultType QThreadFunction::takeResult() const

Nimmt (verschiebt) den Ergebnistyp, der von der in einem separaten Thread ausgeführten Funktion gemeldet wurde.

Siehe auch QFuture::takeResult().

QThreadPool *QThreadFunction::threadPool() const

Gibt den Thread-Pool zurück, der bei der Ausführung des Aufrufs verwendet wird. Wenn nullptr zurückgegeben wird, wird QThreadPool::globalInstance() verwendet.

Siehe auch setThreadPool().