Класс QFuture

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

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

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

• const_iterator

Типы Public

Функции Public

Открытые переменные

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

Класс 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()

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

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

Конструирует копию other.

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

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

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

T QFuture::operator T() const

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

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

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

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

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

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

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

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