命名空间
变体
操作

std::stop_source

来自 cppreference.com
< cpp‎ | thread
 
 
并发支持库
线程
(C++11)
(C++20)
this_thread 命名空间
(C++11)
(C++11)
(C++11)
协作式取消
(C++20)
stop_source
(C++20)
互斥
(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++26)
危险指针
原子类型
(C++11)
(C++20)
原子类型的初始化
(C++11)(C++20 中已弃用)
(C++11)(C++20 中已弃用)
内存排序
原子操作的自由函数
原子标志的自由函数
 
 
定义在头文件 <stop_token>
class stop_source;
(自 C++20 起)

stop_source 类提供了发出停止请求的方法,例如 std::jthread 取消。对一个 stop_source 对象发出的停止请求对同一关联停止状态的所有 stop_sourcestd::stop_token 可见;为关联的 std::stop_token 注册的任何 std::stop_callback 将被调用,任何在关联的 std::condition_variable_any 对象上等待的 std::stop_token 将被唤醒。

一旦发出停止请求,就不能撤回。额外的停止请求不会有任何效果。

内容

[编辑] 成员函数

构造新的 stop_source 对象
(公有成员函数) [编辑]
析构 stop_source 对象
(公有成员函数) [编辑]
赋值 stop_source 对象
(公有成员函数) [编辑]
修饰符
为关联的停止状态(如果有)发出停止请求
(公有成员函数) [编辑]
交换两个 stop_source 对象
(公有成员函数) [编辑]
观察者
返回关联停止状态的 stop_token
(公有成员函数) [编辑]
检查关联的停止状态是否已被请求停止
(公有成员函数) [编辑]
检查关联的停止状态是否可以被请求停止
(公有成员函数) [编辑]

[编辑] 非成员函数

比较两个 std::stop_source 对象
(函数) [编辑]
专门化 std::swap 算法
(函数) [编辑]

[编辑] 辅助标签

一个用于 stop_source 的标签,用于在构造时指示没有关联的停止状态
(标签)[编辑]

[编辑] 注释

为了 std::jthread 的取消目的,应使用 get_stop_source()std::jthread 对象中检索 stop_source 对象;或者使用 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