std::stop_source
来自cppreference.com
<tbody>
</tbody>
| 在标头 <stop_token> 定义
|
||
class stop_source; |
(C++20 起) | |
stop_source 类提供一种发出停止请求的方法，例如用于 std::jthread 的取消等。对一个 stop_source 对象作出的停止请求，对所有拥有同一关联停止状态的 stop_source 与 std::stop_token 都可见；为关联 std::stop_token 注册的任何 std::stop_callback 都会被调用，并且在关联 std::stop_token 上等待的任何 std::condition_variable_any 对象都会被唤醒。
一旦请求了停止，就不能撤销。额外的停止请求无效果。
成员函数
构造新的 stop_source 对象 (公开成员函数) | |
析构 stop_source 对象 (公开成员函数) | |
赋值 stop_source 对象 (公开成员函数) | |
修改器 | |
| 对关联停止状态做出停止请求，若它存在 (公开成员函数) | |
交换两个 stop_source 对象 (公开成员函数) | |
观察器 | |
返回关联停止状态的 stop_token (公开成员函数) | |
| 检查是否已请求关联停止状态停止 (公开成员函数) | |
| 检查能否请求关联停止状态停止 (公开成员函数) | |
非成员函数
(C++20) |
比较两个 std::stop_source 对象 (函数) |
(C++20) |
特化 std::swap 算法 (函数) |
辅助标签
(C++20) |
用于 stop_source 的标签，指定构造时没有关联的停止状态 (标签) |
注解
对于 std::jthread 取消的目的而言，应该用 get_stop_source() 从 std::jthread 对象取得 stop_source 对象；或者应该直接从 std::jthread 对象用 request_stop() 请求停止。然后它将使用传入 std::jthread 所调用函数（即其线程上被执行的函数）的实参相同的关联停止状态。
但对于其他用途，可以使用默认构造函数单独构造 stop_source，这会创建新的停止状态。
| 功能特性测试宏 | 值 | 标准 | 功能特性 |
|---|---|---|---|
__cpp_lib_jthread |
201911L |
(C++20) | 停止令牌与结合线程 |
示例
运行此代码
#include <chrono>
#include <iostream>
#include <stop_token>
#include <thread>
using namespace std::chrono_literals;
void worker_fun(int id, std::stop_token stoken)
{
for (int i = 10; i; --i)
{
std::this_thread::sleep_for(300ms);
if (stoken.stop_requested())
{
std::printf(" worker%d 被要求停止\n", id);
return;
}
std::printf(" worker%d 返回睡眠\n", id);
}
}
int main()
{
std::jthread threads[4];
std::cout << std::boolalpha;
auto print = [](const std::stop_source& source)
{
std::printf("stop_source stop_possible = %s, stop_requested = %s\n",
source.stop_possible() ? "true" : "false",
source.stop_requested() ? "true" : "false");
};
// 公共源
std::stop_source stop_source;
print(stop_source);
// 创建工作线程
for (int i = 0; i < 4; ++i)
threads[i] = std::jthread(worker_fun, i + 1, stop_source.get_token());
std::this_thread::sleep_for(500ms);
std::puts("请求停止");
stop_source.request_stop();
print(stop_source);
// 注：jthreads 的析构函数会调用 join，因此无需显式调用
}
可能的输出：
stop_source stop_possible = true, stop_requested = false
worker2 返回睡眠
worker3 返回睡眠
worker1 返回睡眠
worker4 返回睡眠
请求停止
stop_source stop_possible = true, stop_requested = true
worker3 被要求停止
worker1 被要求停止
worker2 被要求停止
worker4 被要求停止