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) |
Шаблонный класс 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 функция-элемент) | |
[править]Функции, не являющиеся элементами
(C++11) | специализация алгоритма 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
