cancellation_token_source 類別

發行項
10/12/2023

cancellation_token_source 類別代表取消某個可取消作業的能力。

語法

class cancellation_token_source;

成員

公用建構函式

名稱	描述
cancellation_token_source	已多載。建構新的 `cancellation_token_source`。來源可用於將某個可取消作業的取消加上標幟。
~cancellation_token_source解構函式

公用方法

名稱	描述
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
語彙基元，其取消作業將會導致取消傳回的語彙基元來源。請注意，傳回的語彙基元來源也可以獨立取消，不受此參數包含的來源影響。

_開始
C++ 標準程式庫反覆運算器，對應至要接聽取消之權杖範圍的開頭。

_結束
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);

參數