stop_source类 参考

停止源类 更多...

#include <stop_token.hpp>

Public 成员函数
	stop_source ()
	默认构造函数
	stop_source (none_t none) noexcept
	构造函数
	stop_source (const stop_source &other) noexcept
	拷贝构造函数
	stop_source (stop_source &&) noexcept=default
	移动构造函数
stop_source &	operator= (const stop_source &other) noexcept
	拷贝赋值运算符
stop_source &	operator= (stop_source &&) noexcept=default
	移动赋值运算符
	~stop_source ()
	析构函数
MSTL_NODISCARD bool	stop_possible () const noexcept
	检查是否具有停止能力
MSTL_NODISCARD bool	stop_requested () noexcept
	检查是否已请求停止
MSTL_NODISCARD bool	request_stop () noexcept
	请求停止
MSTL_NODISCARD stop_token	get_token () const noexcept
	获取停止令牌
void	swap (stop_source &other) noexcept
	交换两个停止源
MSTL_NODISCARD bool	operator== (const stop_source &rhs) const noexcept
	相等比较运算符
MSTL_NODISCARD bool	operator!= (const stop_source &rhs) const noexcept
	不等比较运算符

详细描述

停止源类

停止源用于发起停止请求，可以创建stop_token供其他线程查询。 一个stop_source对应一个停止状态，多个stop_token可以共享这个状态。

在文件 stop_token.hpp 第 471 行定义.

构造及析构函数说明

stop_source() [1/3]

stop_source::stop_source ( )

inline

默认构造函数

创建具有停止能力的stop_source。

在文件 stop_token.hpp 第 481 行定义.

被这些函数引用 operator!=(), operator=(), operator=(), operator==(), stop_source(), stop_source(), swap() , 以及 ~stop_source().

stop_source() [2/3]

stop_source::stop_source ( none_t none )

inlineexplicitnoexcept

构造函数

参数

none

空标记

创建不具有停止能力的stop_source。

在文件 stop_token.hpp 第 489 行定义.

引用了 none.

stop_source() [3/3]

stop_source::stop_source ( const stop_source & other )

inlinenoexcept

拷贝构造函数

参数

other

要拷贝的stop_source

在文件 stop_token.hpp 第 495 行定义.

引用了 stop_source().

~stop_source()

stop_source::~stop_source ( )

inline

析构函数

减少stop_source计数，当计数为0时清除停止能力。

在文件 stop_token.hpp 第 525 行定义.

引用了 stop_source().

成员函数说明

get_token()

MSTL_NODISCARD stop_token stop_source::get_token ( ) const

inlinenoexcept

获取停止令牌

返回

关联的stop_token

在文件 stop_token.hpp 第 564 行定义.

request_stop()

MSTL_NODISCARD bool stop_source::request_stop ( )

inlinenoexcept

请求停止

返回

是否成功请求停止（首次请求返回true）

设置停止标志并执行所有注册的回调函数。

在文件 stop_token.hpp 第 553 行定义.

引用了 stop_possible().

stop_possible()

MSTL_NODISCARD bool stop_source::stop_possible ( ) const

inlinenoexcept

检查是否具有停止能力

返回

是否具有停止能力

在文件 stop_token.hpp 第 535 行定义.

被这些函数引用 request_stop() , 以及 stop_requested().

stop_requested()

MSTL_NODISCARD bool stop_source::stop_requested ( )

inlinenoexcept

检查是否已请求停止

返回

是否已请求停止

在文件 stop_token.hpp 第 543 行定义.

引用了 stop_possible().

swap()

void stop_source::swap ( stop_source & other )

inlinenoexcept

交换两个停止源

参数

other

要交换的停止源

在文件 stop_token.hpp 第 572 行定义.

引用了 stop_source().

---

该类的文档由以下文件生成:

• stop_token.hpp