std::stop_token::stop_possible

来自cppreference.com
< cpp‎ | thread‎ | stop token
 
 
并发支持库
线程
(C++11)
(C++20)
this_thread 命名空间
(C++11)
(C++11)
(C++11)
协作式取消
互斥
通用锁管理
(C++11)
(C++11)
(C++11)
(C++11)
条件变量
(C++11)
信号量
闩与屏障
(C++20)
(C++20)
未来体
(C++11)
(C++11)
(C++11)
安全回收
风险指针
原子类型
(C++11)
(C++20)
原子类型的初始化
(C++11)(C++20 弃用)
(C++11)(C++20 弃用)
内存定序
(C++11)(C++26 弃用)
原子操作的自由函数
原子标志的自由函数
 
 
bool stop_possible()constnoexcept;
(C++20 起)

检查 stop_token 对象是否拥有关联停止状态,而该状态已被请求停止或拥有关联的 std::stop_source 对象。

默认构造的 stop_token 无关联停止状态,从而不能请求停止;若未作出停止请求,则不存在 std::stop_source 对象的关联停止状态亦不能请求停止。

目录

[编辑]参数

(无)

[编辑]返回值

stop_token 对象无关联停止状态,或仍未收到停止请求且无关联的 std::stop_source 对象则为 false;否则为 true

[编辑]注解

stop_token 对象拥有关联停止状态且已作出停止请求,则此函数仍返回 true

stop_token 对象拥有来自 std::jthread 的关联停止状态——例如 stop_token 是通过在 std::jthread 对象上调用 get_stop_token() 取得的——则此函数始终返回 truestd::jthread 始终拥有内部的 std::stop_source 对象,即使该线程的调用函数不检查它。

[编辑]示例

#include <chrono>#include <condition_variable>#include <format>#include <iostream>#include <mutex>#include <string_view>#include <thread>usingnamespace std::chrono_literals;   int main(){std::cout<<std::boolalpha;auto print =[](std::string_view name, conststd::stop_token& token){std::cout<<std::format("{}: stop_possible = {:s}, stop_requested = {:s}\n", name, token.stop_possible(), token.stop_requested());};   // 将会监听停止请求的工作线程auto stop_worker =std::jthread([](std::stop_token stoken){for(int i =10; i;--i){std::this_thread::sleep_for(300ms);if(stoken.stop_requested()){std::cout<<" 嗜睡工人已被请求停止\n";return;}std::cout<<" 嗜睡工人回去睡觉\n";}});   // 完成后才停止的工作线程auto inf_worker =std::jthread([](){for(int i =5; i;--i){std::this_thread::sleep_for(300ms);std::cout<<" 如愿持续运行\n";}});   std::stop_token def_token;std::stop_token stop_token = stop_worker.get_stop_token();std::stop_token inf_token = inf_worker.get_stop_token(); print("def_token ", def_token); print("stop_token", stop_token); print("inf_token ", inf_token);   std::cout<<"\n请求并结合 stop_worker:\n"; stop_worker.request_stop(); stop_worker.join();   std::cout<<"\n请求并结合 inf_worker:\n"; inf_worker.request_stop(); inf_worker.join();std::cout<<'\n';   print("def_token ", def_token); print("stop_token", stop_token); print("inf_token ", inf_token);}

可能的输出:

def_token : stop_possible = false, stop_requested = false stop_token: stop_possible = true, stop_requested = false inf_token : stop_possible = true, stop_requested = false   请求并结合 stop_worker: 如愿持续运行 嗜睡工人已被请求停止   请求并结合 inf_worker: 如愿持续运行 如愿持续运行 如愿持续运行 如愿持续运行   def_token : stop_possible = false, stop_requested = false stop_token: stop_possible = true, stop_requested = true inf_token : stop_possible = true, stop_requested = true
close