cancellation_token クラス

cancellation_token クラスは、ある操作の取り消しが要求されたかどうかを判断する機能を表します。 特定のトークンを task_groupstructured_task_group、または task に関連付けると、暗黙的な取り消しを指定できます。 関連付けられた cancellation_token_source が取り消されたときに、取り消すためにポーリングしたり、コールバックを登録したりすることもできます。

class cancellation_token;

メンバー

パブリック コンストラクター

名前

説明

cancellation_token::cancellation_token コンストラクター

cancellation_token::~cancellation_token デストラクター

パブリック メソッド

名前

説明

cancellation_token::deregister_callback メソッド

登録時に返された cancellation_token_registration オブジェクトに基づく register メソッドによって以前に登録されたコールバックを削除します。

cancellation_token::is_cancelable メソッド

このトークンを取り消すことができるかどうかを示す値を返します。

cancellation_token::is_canceled メソッド

トークンが取り消された場合は true を返します。

cancellation_token::none メソッド

取り消しの対象とはならないキャンセル トークンを返します。

cancellation_token::register_callback メソッド

コールバック関数をトークンに登録します。 トークンが取り消された場合、コールバックが行われます。 このメソッドが呼び出された時点で既にコールバックが取り消されている場合、コールバックは即座に同期的に行われることに注意してください。

パブリック演算子

名前

説明

cancellation_token::operator!= 演算子

cancellation_token::operator= 演算子

cancellation_token::operator== 演算子

継承階層

cancellation_token

必要条件

ヘッダー: pplcancellation_token.h

名前空間: concurrency

参照

関連項目

concurrency 名前空間