Пространства имён
Варианты
Действия

std::promise

Материал из cppreference.com
< cpp‎ | thread
 
 
Библиотека поддержки конкуренции
Ветви
(C++11)
(C++20)
(C++20)
Пространство имён this_thread
(C++11)
(C++11)
(C++11)
Атомарные типы
(C++11)
(C++20)
Инициализация атомарных типов
(C++11)(устарело в C++20)
(C++11)(устарело в C++20)
(C++11)(устарело в C++20)
Функции освобождения для атомарных операций
Функции освобождения для атомарных флагов
Упорядочивание памяти
Взаимное исключение
(C++11)
Общее управление блокировкой
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Условные переменные
(C++11)
Семафоры
Защёлки и барьеры
(C++20)
(C++20)
Фьючерсы
promise
(C++11)
(C++11)
(C++11)
(C++11)
 
std::promise
Функции-элементы
Получение результата
Установка результата
Функции, не являющиеся элементами
Вспомогательные классы
 
Определено в заголовочном файле <future>
template< class R > class promise;
(1) (начиная с C++11)
template< class R > class promise<R&>;
(2) (начиная с C++11)
template<>          class promise<void>;
(3) (начиная с C++11)
1) базовый шаблон
2) не void специализация, используемая для передачи объектов между потоками
3) void специализация, используемая для передачи событий без сохранения состояния

Шаблонный класс std::promise предоставляет средство для хранения значения или исключения, которые позже получаются асинхронно через объект std::future, созданный объектом std::promise. Обратите внимание, что объект std::promise предназначен для использования только один раз.

Каждый promise связан собщим состоянием, которое содержит некоторую информацию о состоянии и результат, который может быть ещё не оценён, оценён как значение (возможно, void) или оценён как исключение. promise может делать три вещи с общим состоянием:

  • делать готовым: promise сохраняет результат или исключение в общем состоянии. Помечает состояние как готовое и разблокирует любой поток, ожидающий future, связанного с общим состоянием.
  • освобождать: promise отказывается от ссылки на общее состояние. Если это была последняя такая ссылка, общее состояние уничтожается. Если это не было общим состоянием, созданным std::async, которое ещё не готово, эта операция не блокируется.
  • освобождать: promise сохраняет исключение типа std::future_error с кодом ошибки std::future_errc::broken_promise, делает общее состояние готовым, а затем освобождает его.

promise это конец канала связи promise-future: операция, которая сохраняет значение в общем состоянии синхронизируется с (как определено в std::memory_order) успешным возвратом из любой функции, ожидающей общего состояния (например, std::future::get). В противном случае одновременный доступ к одному и тому же общему состоянию может конфликтовать: например, несколько вызывающих объектов std::shared_future::get должны либо быть доступны только для чтения, либо обеспечивать внешнюю синхронизацию.

Содержание

[править] Функции-элементы

создает объект promise
(public функция-элемент) [править]
разрушает объект promise
(public функция-элемент) [править]
присваивает общее состояние
(public функция-элемент) [править]
обменивает два объекта promise
(public функция-элемент) [править]
Получение результата
возвращает future, связанный с обещанным результатом
(public функция-элемент) [править]
Установка результата
устанавливает результат в определённое значение
(public функция-элемент) [править]
устанавливает результат в определённое значение, доставляя уведомление только при выходе из потока
(public функция-элемент) [править]
устанавливает результат, чтобы указать исключение
(public функция-элемент) [править]
устанавливает результат для указания исключения при доставке уведомления только при выходе из потока
(public функция-элемент) [править]

[править] Функции, не являющиеся элементами

специализация алгоритма std::swap
(шаблон функции) [править]

[править] Вспомогательные классы

специализация свойства типа std::uses_allocator
(специализация шаблона класса) [править]

[править] Пример

В этом примере показано, как promise<int> можно использовать в качестве сигналов между потоками.

#include <vector>
#include <thread>
#include <future>
#include <numeric>
#include <iostream>
#include <chrono>
 
void accumulate(std::vector<int>::iterator first,
                std::vector<int>::iterator last,
                std::promise<int> accumulate_promise)
{
    int sum = std::accumulate(first, last, 0);
    accumulate_promise.set_value(sum);  // Уведомить future
}
 
void do_work(std::promise<void> barrier)
{
    std::this_thread::sleep_for(std::chrono::seconds(1));
    barrier.set_value();
}
 
int main()
{
    // Демонстрирует использование promise<int> для передачи результата между потоками.
    std::vector<int> numbers = { 1, 2, 3, 4, 5, 6 };
    std::promise<int> accumulate_promise;
    std::future<int> accumulate_future = accumulate_promise.get_future();
    std::thread work_thread(accumulate, numbers.begin(), numbers.end(),
                            std::move(accumulate_promise));
 
    // future::get() будет ждать, пока у future не будет корректного результата,
    // и извлечёт его.
    // Вызов wait() перед get() не требуется
    //accumulate_future.wait();  // ждать результата
    std::cout << "результат=" << accumulate_future.get() << '\n';
    work_thread.join();  // ждать завершения потока
 
    // Демонстрирует использование promise<void> для передачи состояния между потоками.
    std::promise<void> barrier;
    std::future<void> barrier_future = barrier.get_future();
    std::thread new_work_thread(do_work, std::move(barrier));
    barrier_future.wait();
    new_work_thread.join();
}

Вывод:

результат=21