Класс QFuture

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

Этот класс был представлен в Qt 4.4.

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

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

• const_iterator

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

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

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

Для запуска вычисления используйте один из 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 QFuture<T> &other)

Создает копию other.

См. также operator=().

QFuture::QFuture()

Создает пустое, отменённое будущее.

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

Присваивает other этому будущему и возвращает ссылку на это будущее.

QFuture::~QFuture()

Уничтожает будущее.

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

QFuture::const_iterator QFuture::begin() const

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

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

void QFuture::cancel()

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

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

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

QFuture::const_iterator QFuture::constBegin() const

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

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

QFuture::const_iterator QFuture::constEnd() const

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

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

QFuture::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()

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

T QFuture::operator T() const

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

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

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

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

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

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