Класс QFuture

Класс QFuture представляет собой результат асинхронного вычисления. Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются потокобезопасными за исключением следующих:

• const_iterator

Открытые типы

Открытые функции

Подробное описание

Класс QFuture представляет результат асинхронного вычисления.

Для запуска вычисления используйте один из API в рамках фреймворка Qt Concurrent.

QFuture позволяет потокам синхронизироваться с одним или несколькими результатами, которые будут готовы в более поздний момент времени. Результат может быть любого типа, который имеет конструктор по умолчанию и конструктор копирования. Если результат недоступен в момент вызова функций result(), resultAt() или results(), QFuture будет ждать, пока результат не станет доступным. Вы можете использовать функцию isResultReadyAt() для определения готовности результата. Для объектов QFuture, которые сообщают о более чем одном результате, функция resultCount() возвращает количество последовательных результатов. Это означает, что всегда безопасно итерироваться по результатам от 0 до resultCount().

QFuture предоставляет итератор по типу Java (QFutureIterator) и итератор по типу STL (QFuture::const_iterator). Использование этих итераторов — еще один способ доступа к результатам в будущем.

QFuture также предоставляет способы взаимодействия с выполняющимся вычислением. Например, вычисление можно отменить с помощью функции cancel(). Чтобы приостановить вычисление, используйте функцию setPaused() или одну из удобных функций pause(), resume() или togglePaused(). Имейте в виду, что не все асинхронные вычисления могут быть отменены или приостановлены. Например, будущее, возвращаемое QtConcurrent::run(), не может быть отменено; но будущее, возвращаемое QtConcurrent::mappedReduced(), может.

Информация о прогрессе предоставляется функциями progressValue(), progressMinimum(), progressMaximum() и progressText(). Функция waitForFinished() заставляет вызывающий поток заблокироваться и ждать завершения вычисления, гарантируя, что все результаты доступны.

Состояние вычисления, представленного объектом QFuture, можно запросить с помощью функций isCanceled(), isStarted(), isFinished(), isRunning() или isPaused().

QFuture — это лёгкий класс со счетчиком ссылок, который можно передавать по значению.

QFuture<void> специализируется так, чтобы не содержать функции извлечения результатов. Любой QFuture<T> может быть присвоен или скопирован в QFuture<void>, тоже. Это полезно, если нужна только информация о состоянии или прогрессе, а не фактические данные результата.

Чтобы взаимодействовать с выполняемыми задачами с помощью сигналов и слотов, используйте QFutureWatcher.

См. также QFutureWatcher и Qt Concurrent.

Документация по типам членов

typedef QFuture::ConstIterator

Синоним Qt-стиля для QFuture::const_iterator.

Документация по функциям-членам

QFuture::QFuture()

Конструирует пустое, отменённое будущее.

const_iterator QFuture::begin() const

Возвращает постоянный итератор STL, указывающий на первый результат в будущем.

См. также constBegin() и end().

void QFuture::cancel()

Отменяет асинхронное вычисление, представленное этим будущим. Обратите внимание, что отмена происходит асинхронно. Используйте waitForFinished() после вызова cancel(), когда вам нужна синхронная отмена.

Доступные в настоящее время результаты все еще могут быть обработаны в отменённом будущем, но новые результаты не будут доступны после вызова этой функции. Любой объект QFutureWatcher, который отслеживает это будущее, не будет отправлять сигналы готовности прогресса и результата для отменённого будущего.

Обратите внимание, что не все асинхронные вычисления могут быть отменены. Например, будущее, возвращаемое QtConcurrent::run(), не может быть отменено; но будущее, возвращаемое QtConcurrent::mappedReduced(), может.

const_iterator QFuture::constBegin() const

Возвращает постоянный итератор STL, указывающий на первый результат в будущем.

См. также begin() и constEnd().

const_iterator QFuture::constEnd() const

Возвращает постоянный итератор STL-стиля, указывающий на воображаемый результат после последнего результата в будущем.

См. также constBegin() и end().

const_iterator QFuture::end() const

Возвращает постоянный итератор STL-стиля, указывающий на воображаемый результат после последнего результата в будущем.

См. также begin() и constEnd().

bool QFuture::isCanceled() const

Возвращает true , если асинхронное вычисление было отменено с помощью функции cancel(); в противном случае возвращает false.

Обратите внимание, что вычисление может все еще выполняться, даже если эта функция возвращает true. См. cancel() для получения более подробной информации.

bool QFuture::isFinished() const

Возвращает true , если асинхронное вычисление, представленное этим будущим, завершено; в противном случае возвращает false.

bool QFuture::isPaused() const

Возвращает true , если асинхронное вычисление было приостановлено с помощью функции pause(); в противном случае возвращает false.

Обратите внимание, что вычисление может все еще выполняться, даже если эта функция возвращает true. См. setPaused() для получения более подробной информации.

См. также setPaused() и togglePaused().

bool QFuture::isResultReadyAt(int index) const

Возвращает true , если результат в index немедленно доступен; в противном случае возвращает false.

См. также resultAt() и resultCount().

bool QFuture::isRunning() const

Возвращает true , если асинхронное вычисление, представленное этим будущим, в настоящее время выполняется; в противном случае возвращает false.

bool QFuture::isStarted() const

Возвращает true , если асинхронное вычисление, представленное этим будущим, было запущено; в противном случае возвращает false.

void QFuture::pause()

Приостанавливает асинхронное вычисление, представленное этим будущим. Это метод удобства, который просто вызывает setPaused(true).

См. также resume().

int QFuture::progressMaximum() const

Возвращает максимальное значение progressValue().

См. также progressValue() и progressMinimum().

int QFuture::progressMinimum() const

Возвращает минимальное значение progressValue().

См. также progressValue() и progressMaximum().

QString QFuture::progressText() const

Возвращает (необязательное) текстовое представление прогресса, как сообщается асинхронным вычислением.

Обратите внимание, что не все вычисления предоставляют текстовое представление прогресса, и поэтому эта функция может возвращать пустую строку.

int QFuture::progressValue() const

Возвращает текущее значение прогресса, которое находится между progressMinimum() и progressMaximum().

См. также progressMinimum() и progressMaximum().

T QFuture::result() const

Возвращает первый результат в будущем. Если результат немедленно недоступен, эта функция заблокируется и дождется, пока результат не станет доступным. Это метод удобства для вызова resultAt(0).

См. также resultAt() и results().

T QFuture::resultAt(int index) const

Возвращает результат в index в будущем. Если результат немедленно недоступен, эта функция заблокируется и дождется, пока результат не станет доступным.

См. также result(), results() и resultCount().

int QFuture::resultCount() const

Возвращает количество непрерывных результатов, доступных в этом будущем. Фактическое количество сохранённых результатов может отличаться от этого значения из-за пробелов в наборе результатов. Безопасно итерировать по результатам от 0 до resultCount().

См. также result(), resultAt() и results().

QList<T> QFuture::results() const

Возвращает все результаты из будущего. Если результаты немедленно недоступны, эта функция заблокируется и дождется, пока они не станут доступными.

См. также result(), resultAt() и resultCount().

void QFuture::resume()

Возобновляет асинхронное вычисление, представленное этим будущим. Это метод удобства, который просто вызывает setPaused(false).

См. также pause().

void QFuture::setPaused(bool paused)

Если paused равно true, эта функция приостанавливает асинхронное вычисление, представленное будущим. Если вычисление уже приостановлено, эта функция ничего не делает. Любой объект QFutureWatcher, который наблюдает за этим будущим, перестанет доставлять сигналы о готовности прогресса и результата, пока будущее приостановлено. Доставка сигналов продолжится, как только будущее будет возобновлено.

Если paused равно false, эта функция возобновляет асинхронное вычисление. Если вычисление ранее не было приостановлено, эта функция ничего не делает.

Обратите внимание, что не все вычисления могут быть приостановлены. Например, будущее, возвращаемое QtConcurrent::run(), не может быть приостановлено; но будущее, возвращаемое QtConcurrent::mappedReduced(), может.

См. также isPaused(), pause(), resume() и togglePaused().

void QFuture::togglePaused()

Переключает состояние приостановки асинхронного вычисления. Другими словами, если вычисление в настоящее время приостановлено, вызов этой функции возобновляет его; если вычисление выполняется, оно приостанавливается. Это метод удобства для вызова setPaused(!isPaused()).

См. также setPaused(), pause() и resume().

void QFuture::waitForFinished()

Ожидает завершения асинхронного вычисления (включая отмененные cancel() вычисления).

QFuture::operator T() const

Возвращает первый результат в будущем. Если результат немедленно недоступен, эта функция заблокируется и дождется, пока результат не станет доступным. Это метод удобства для вызова result() или resultAt(0).

См. также result(), resultAt() и results().

bool QFuture::operator!=(const QFuture &other) const

Возвращает true , если other не является копией этого будущего; в противном случае возвращает false.

bool QFuture::operator==(const QFuture &other) const

Возвращает true , если other является копией этого будущего; в противном случае возвращает false.