std::stop_token

定义于头文件 `<stop_token>`
class stop_token;		(自 C++20 起)

stop_token 类提供了检查是否已发出或可以发出停止请求的方法，用于其关联的 std::stop_source 对象。它本质上是关联停止状态的线程安全“视图”。

stop_token 也可以传递给 std::stop_callback 的构造函数，这样，如果请求 stop_token 的关联 std::stop_source 停止，则将调用回调。并且 stop_token 可以传递给 std::condition_variable_any 的可中断等待函数，以在请求停止时中断条件变量的等待。

[edit] 成员别名模板

类型	定义
callback_type<Callback> (自 C++26 起)	std::stop_callback<Callback>

[edit] 成员函数

(构造函数)	构造新的 `stop_token` 对象 (公有成员函数) [编辑]
(析构函数)	析构 `stop_token` 对象 (公有成员函数) [编辑]
operator=	赋值 `stop_token` 对象 (公有成员函数) [编辑]
修饰符
swap	交换两个 `stop_token` 对象 (公有成员函数) [编辑]
观察器
stop_requested	检查是否已请求关联的停止状态停止 (公有成员函数) [编辑]
stop_possible	检查是否可以请求关联的停止状态停止 (公有成员函数) [编辑]

[edit] 非成员函数

operator== (C++20)	比较两个 `std::stop_token` 对象 (函数) [编辑]
swap(std::stop_token) (C++20)	特化 std::swap 算法 (函数) [编辑]

[edit] 注解

stop_token 对象通常不是独立构造的，而是从 std::jthread 或 std::stop_source 检索的。这使其与 std::jthread 或 std::stop_source 共享相同的关联停止状态。

特性测试宏	值	Std	特性
`__cpp_lib_jthread`	`201911L`	(C++20)	停止令牌和 joining thread

[edit] 示例

运行此代码

#include <iostream>
#include <thread>
 
using namespace std::literals::chrono_literals;
 
void f(std::stop_token stop_token, int value)
{
    while (!stop_token.stop_requested())
    {
        std::cout << value++ << ' ' << std::flush;
        std::this_thread::sleep_for(200ms);
    }
    std::cout << std::endl;
}
 
int main()
{
    std::jthread thread(f, 5); // prints 5 6 7 8... for approximately 3 seconds
    std::this_thread::sleep_for(3s);
    // The destructor of jthread calls request_stop() and join().
}

可能的输出

5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

编译器支持
独立和宿主式
语言
标准库
标准库头文件
具名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
诊断库
内存管理库
元编程库 (C++11)
通用工具库
容器库
迭代器库
范围库 (C++20)
算法库
字符串库
文本处理库
数值库
日期和时间库
输入/输出库
文件系统库 (C++17)
并发支持库 (C++11)
执行控制库 (C++26)
技术规范
符号索引
外部库

cppreference.cn

命名空间

变体

视图

操作