std:: stop_source

stop_source 类提供了发出停止请求的方法，例如用于 std::jthread 的取消操作。对一个 stop_source 对象发出的停止请求，对所有共享同一关联停止状态的 stop_source 和 std::stop_token 均可见；任何为关联的 std::stop_token 注册的 std::stop_callback 将被调用，并且任何等待关联 std::stop_token 的 std::condition_variable_any 对象将被唤醒。

一旦请求停止，该请求将无法撤销。额外的停止请求不会产生任何效果。

成员函数

非成员函数

辅助标签

注释

为实现 std::jthread 的取消操作，应通过 get_stop_source() 从 std::jthread 对象获取 stop_source 对象；或直接通过 request_stop() 从 std::jthread 对象请求停止。这将使用与传入 std::jthread 调用函数参数（即在其线程上执行的函数）相同的关联停止状态。

对于其他用途，可以通过默认构造函数单独构造一个 stop_source ，这会创建新的停止状态。

示例

#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");
    };
    // 公共停止源
    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);
    // 注意：jthread 的析构函数将调用 join，因此无需显式调用
}

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
请求停止
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