std::promise

 

C++

言語

コンセプト

ユーティリティライブラリ

ストリングスライブラリ

コンテナライブラリ

アルゴリズムライブラリ

イテレータライブラリ

ニューメリックスライブラリ

入力/出力ライブラリ

ローカライゼーションライブラリ

正規表現ライブラリ (C++11)

アトミック操作ライブラリ (C++11)

スレッドのサポートライブラリ (C++11)

 

スレッド支援ライブラリ

スレッド
thread (C++11)
this_thread名前空間
get_id (C++11) yield (C++11)	sleep_for (C++11) sleep_until (C++11)
排他制御
mutex (C++11) timed_mutex (C++11)	recursive_mutex (C++11) recursive_timed_mutex (C++11)
汎用ロック管理
lock_guard (C++11) unique_lock (C++11) defer_lock_t try_to_lock_t adopt_lock_t (C++11) (C++11) (C++11)	lock (C++11) try_lock (C++11) defer_lock try_to_lock adopt_lock (C++11) (C++11) (C++11)
条件変数
condition_variable (C++11)
condition_variable_any (C++11)
notify_all_at_thread_exit (C++11)
cv_status (C++11)
先物(future)
promise (C++11) future (C++11) shared_future (C++11) packaged_task (C++11) async (C++11)	launch (C++11) future_status (C++11) future_error (C++11) future_category (C++11) future_errc (C++11)

 

std::promise

メンバ関数

promise::promise

promise::~promise

promise::operator=

promise::swap

結果の取得

promise::get_future

結果の設定

promise::set_value

promise::set_value_at_thread_exit

promise::set_exception

promise::set_exception_at_thread_exit

 

Defined in header <future>
template< class T > class promise;	(1)	(C++11およびそれ以降)
template< class T > class promise<T&>;	(2)	(C++11およびそれ以降)
template<>          class promise<void>;	(3)	(C++11およびそれ以降)

1) 基本テンプレート

2) スレッド間でオブジェクトをやり取りするための非void特殊化

3) スレッド間でステートレスなイベントをやり取りするためのvoid特殊化

クラステンプレートstd::promiseは、std::promiseが作成するstd::futureオブジェクトを介して、後に非同期に取得される値を格納するための機能を提供します.

各promiseは状態情報と、まだ評価できないかもしれないが、評価すると値(void値も可)または例外として評価される「結果」をひとつの「共有状態」と紐付けます。promiseは共有状態について以下の3つのことを行います。

• ready 状態にする: promiseは共有状態に結果もしくは例外を格納し、ready 状態にして共有状態に紐付いたfutureを待っているスレッドをアンブロックします。
• 解放する: promiseは共有状態への参照を破棄します。破棄された参照が最後の参照だった場合、共有状態も破棄されます。共有状態がstd::asyncを使って作成された共有状態でかつready状態である場合以外は、この操作はブロックしません。
• 破棄する: promiseはエラーコードstd::future_errc::broken_promiseをもつstd::future_error型の例外を格納し、共有状態をready 状態にし、その後解放します。

promiseはpromise-futureコミュニケーションチャネルの"push"側です。共有状態に値を格納する操作は共有状態を待っている関数(例えばstd::shared_future::get)が成功して返るのと(std::memory_orderに定義されるように)「同期」します。同じ共有状態に対する同時アクセスは衝突することがあります。例えば、std::shared_future::getが同時に複数呼び出される場合、全て読み込み専用であるか、または外部で同期されなければなりません。

メンバ関数

(constructor)	promiseオブジェクトを作成します (パブリックメンバ関数)
(destructor)	promiseオブジェクトをデストラクトします (パブリックメンバ関数)
operator=	共有状態を代入します (パブリックメンバ関数)
swap	スワップ2約束オブジェクト Original: swaps two promise objects The text has been machine-translated via Google Translate. You can help to correct and verify the translation. Click here for instructions. (パブリックメンバ関数)
結果の取得
get_future	は約束された結果に関連付けられfutureを返す最初の引数が2番目の値より小さい'の場合 Original: returns a future associated with the promised result The text has been machine-translated via Google Translate. You can help to correct and verify the translation. Click here for instructions. (パブリックメンバ関数)
結果の設定
set_value	sets the result to specific value (パブリックメンバ関数)
set_value_at_thread_exit	唯一のスレッドの終了時に通知を提供しながら、特定の値に結果を設定します Original: sets the result to specific value while delivering the notification only at thread exit The text has been machine-translated via Google Translate. You can help to correct and verify the translation. Click here for instructions. (パブリックメンバ関数)
set_exception	例外を示すために結果を設定します Original: sets the result to indicate an exception The text has been machine-translated via Google Translate. You can help to correct and verify the translation. Click here for instructions. (パブリックメンバ関数)
set_exception_at_thread_exit	のみスレッドの終了時に通知を提供しながら、例外を示すために結果を設定します Original: sets the result to indicate an exception while delivering the notification only at thread exit The text has been machine-translated via Google Translate. You can help to correct and verify the translation. Click here for instructions. (パブリックメンバ関数)

非メンバ関数

std::swap(std::promise) (C++11)	std::swapアルゴリズムの特殊化 (関数テンプレート)

ヘルパークラス

std::uses_allocator<std::promise> (C++11)	std::uses_allocator型形質を専門としています Original: specializes the std::uses_allocator type trait The text has been machine-translated via Google Translate. You can help to correct and verify the translation. Click here for instructions. (クラステンプレートの特殊化の2つの値を比較します)