std::promise

template< class R > class promise;

template< class R > class promise<R&>;

template<> class promise<void>;

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

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

• подготовка: promise сохраняет результат или исключение в общем состоянии. Помечает состояние как готовое и разблокирует любой поток, ожидающий значения в будущем, связанном с общим состоянием.
• освобождение: 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 должны быть либо только для чтения, либо обеспечивать внешнюю синхронизацию.

Члены-функции

Нечлены-функции

Вспомогательные классы

Пример

#include <chrono>
#include <future>
#include <iostream>
#include <numeric>
#include <thread>
#include <vector>
 
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); // Notify future
}
 
void do_work(std::promise<void> barrier)
{
    std::this_thread::sleep_for(std::chrono::seconds(1));
    barrier.set_value();
}
 
int main()
{
    // Demonstrate using promise<int> to transmit a result between threads.
    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() will wait until the future has a valid result and retrieves it.
    // Calling wait() before get() is not needed
    // accumulate_future.wait(); // wait for result
    std::cout << "result=" << accumulate_future.get() << '\n';
    work_thread.join(); // wait for thread completion
 
    // Demonstrate using promise<void> to signal state between threads.
    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();
}

result=21