cancellation_token_source クラス

cancellation_token_source クラスは、取り消し可能な操作を取り消す機能を表します。

構文

class cancellation_token_source;

メンバー

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

名前	説明
cancellation_token_source	過負荷です。 新しい cancellation_token_source を構築します。 ソースを使用して、一部の取り消し可能な操作について取り消しのフラグを設定できます。
~cancellation_token_source Destructor

パブリック メソッド

名前	説明
cancel	トークンを取り消します。 トークンを利用するすべての task_group、structured_task_group、および task は、このメソッドが呼び出されたときに取り消され、次の割り込みポイントで例外がスローされます。
create_linked_source	過負荷です。 指定されたトークンが取り消されたときに取り消される cancellation_token_source を作成します。
get_token	このソースに関連付けられたキャンセル トークンを返します。 返されたトークンは、取り消すためにポーリングしたり、取り消しが発生した場合にコールバックを指定したりできます。

パブリック演算子

名前	説明
operator!=
operator=
operator==

継承階層

cancellation_token_source

必要条件

ヘッダー: pplcancellation_token.h

名前空間: concurrency

~cancellation_token_source

~cancellation_token_source();

cancel

トークンを取り消します。 トークンを利用するすべての task_group、structured_task_group、および task は、このメソッドが呼び出されたときに取り消され、次の割り込みポイントで例外がスローされます。

void cancel() const;

cancellation_token_source

新しい cancellation_token_source を構築します。 ソースを使用して、一部の取り消し可能な操作について取り消しのフラグを設定できます。

cancellation_token_source();

cancellation_token_source(const cancellation_token_source& _Src);

cancellation_token_source(cancellation_token_source&& _Src);

パラメーター

_Src
コピーまたは移動するオブジェクト。

create_linked_source

指定されたトークンが取り消されたときに取り消される cancellation_token_source を作成します。

static cancellation_token_source create_linked_source(
    cancellation_token& _Src);

template<typename _Iter>
static cancellation_token_source create_linked_source(_Iter _Begin, _Iter _End);

パラメーター

_Iter
反復子の型。

_Src
取り消された場合は、返されるトークン ソースの取り消しの原因となるトークン。 このパラメーターに含まれるソースとは関係なく、返されるトークン ソースも取り消されることに注意してください。

_Begin
取り消しをリッスンするトークンの範囲の先頭に対応する C++ 標準ライブラリ反復子。

_End
取り消しをリッスンするトークンの範囲の末尾に対応する C++ 標準ライブラリ反復子。

戻り値

cancellation_token_source パラメーターによって指定されたトークンが取り消されたときに取り消される _Src。

get_token

このソースに関連付けられたキャンセル トークンを返します。 返されたトークンは、取り消すためにポーリングしたり、取り消しが発生した場合にコールバックを指定したりできます。

cancellation_token get_token() const;

戻り値

このソースに関連付けられたキャンセル トークン。

operator!=

bool operator!= (const cancellation_token_source& _Src) const;

パラメーター

_Src
オペランド。

戻り値

operator=

cancellation_token_source& operator= (const cancellation_token_source& _Src);

cancellation_token_source& operator= (cancellation_token_source&& _Src);

パラメーター

_Src
オペランド。

戻り値

operator==

bool operator== (const cancellation_token_source& _Src) const;

パラメーター

_Src
オペランド。

戻り値

関連項目

コンカレンシー名前空間