std::promise
來自 cppreference.com
| 在標頭檔案 <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::promise 物件建立的 std::future 物件非同步獲取。請注意，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 物件 (公共成員函式) | |
| 銷燬 promise 物件 (公共成員函式) | |
| 賦值共享狀態 (公共成員函式) | |
| 交換兩個 promise 物件 (公共成員函式) | |
Getting the result | |
| 返回與承諾結果關聯的 future (公共成員函式) | |
Setting the result | |
| 將結果設定為特定值 (公共成員函式) | |
| 將結果設定為特定值，僅線上程退出時傳送通知 (公共成員函式) | |
| 將結果設定為指示異常 (公共成員函式) | |
| 將結果設定為指示異常，僅線上程退出時傳送通知 (公共成員函式) | |
[編輯] 非成員函式
| (C++11) |
特化 std::swap 演算法 (函式模板) |
[編輯] 輔助類
| 特化 std::uses_allocator 型別特性 (類模板特化) |
[編輯] 示例
此示例展示瞭如何使用 promise<int> 作為執行緒間的訊號。
執行此程式碼
#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
