std::stop_source
来自 cppreference.cn
| 定义于头文件 <stop_token> |
||
| class stop_source; |
(自 C++20 起) | |
stop_source 类提供了发出停止请求的方法，例如用于 std::jthread 取消。对一个 stop_source 对象发出的停止请求对于所有相同关联停止状态的 stop_source 和 std::stop_token 都是可见的；任何为关联的 std::stop_token 注册的 std::stop_callback(s) 将被调用，并且任何等待关联的 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 取消的目的，stop_source 对象应该使用 get_stop_source() 从 std::jthread 对象中检索；或者应该使用 request_stop() 直接从 std::jthread 对象请求停止。这将使用与传递到 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 is requested to stop\n", id); return; } std::printf(" worker%d goes back to sleep\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"); }; // Common source std::stop_source stop_source; print(stop_source); // Create worker threads 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("Request stop"); stop_source.request_stop(); print(stop_source); // Note: destructor of jthreads will call join so no need for explicit calls }
可能的输出
stop_source stop_possible = true, stop_requested = false worker2 goes back to sleep worker3 goes back to sleep worker1 goes back to sleep worker4 goes back to sleep Request stop stop_source stop_possible = true, stop_requested = true worker3 is requested to stop worker1 is requested to stop worker2 is requested to stop worker4 is requested to stop
