std::stop_token::stop_possible

[[nodiscard]] bool stop_possible() const noexcept;

(since C++20)

Проверяет, имеет ли объект stop_token связанное состояние остановки, и что это состояние либо уже получило запрос на остановку, либо у него есть связанные объект(ы) std::stop_source.

У объекта stop_token по умолчанию нет связанного состояния остановки, и поэтому он не может быть остановлен; связанное состояние остановки, для которого нет объект(ов) std::stop_source, также не может быть остановлено, если такой запрос ещё не был выполнен.

Параметры

(нет)

Возвращаемое значение

false, если у объекта stop_token нет связанного состояния остановки, или он ещё не получил запрос на остановку и нет связанных объект(ов) std::stop_source; true в противном случае.

Примечания

Если объект stop_token имеет связанное состояние остановки и запрос на остановку уже был выполнен, эта функция всё равно возвращает true.

Если объект stop_token имеет связанное состояние остановки от объекта std::jthread — например, объект stop_token был получен вызовом get_stop_token() объекта std::jthread — то эта функция всегда возвращает true. Объект std::jthread всегда имеет внутренний объект std::stop_source, даже если вызывающая функция потока его не проверяет.

Пример

#include <chrono>
#include <condition_variable>
#include <format>
#include <iostream>
#include <mutex>
#include <string_view>
#include <thread>
using namespace std::chrono_literals;
 
int main()
{
    std::cout << std::boolalpha;
    auto print = [](std::string_view name, const std::stop_token& token)
    {
        std::cout << std::format("{}: stop_possible = {:s}, stop_requested = {:s}\n", 
            name, token.stop_possible(), token.stop_requested()
        );
    };
 
    // A worker thread that will listen to stop requests
    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 << "  Sleepy worker is requested to stop\n";
                return;
            }
            std::cout << "  Sleepy worker goes back to sleep\n";
        }
    });
 
    // A worker thread that will only stop when completed
    auto inf_worker = std::jthread([]()
    {
        for (int i = 5; i; --i)
        {
            std::this_thread::sleep_for(300ms);
            std::cout << "  Run as long as we want\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 << "\nRequest and join stop_worker:\n";
    stop_worker.request_stop();
    stop_worker.join();
 
    std::cout << "\nRequest and join 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
 
Request and join stop_worker:
  Run as long as we want
  Sleepy worker is requested to stop
 
Request and join inf_worker:
  Run as long as we want
  Run as long as we want
  Run as long as we want
  Run as long as we want
 
def_token : stop_possible = false, stop_requested = false
stop_token: stop_possible = true, stop_requested = true
inf_token : stop_possible = true, stop_requested = true

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/thread/stop_token/stop_possible