std::stop_token:: stop_possible

Проверяет, имеет ли объект 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()
        );
    };
    // Рабочий поток, который будет слушать запросы на остановку
    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
Request and join stop_worker:
  Работаем столько, сколько хотим
  Сонному рабочему запрошена остановка
Request and join 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