cancellation_token_source 类

项目
06/16/2023

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

命名空间： 并发

~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);

参数