std::stop_source

Определено в заголовке `<stop_token>`
class stop_source;		(с C++20)

Класс stop_source предоставляет средства для отправки запроса на остановку, например, для отмены std::jthread. Запрос на остановку, сделанный для одного объекта stop_source, виден всем stop_source и std::stop_token одного связанного состояния остановки; любые std::stop_callback(ы), зарегистрированные для связанных std::stop_token(ов), будут вызваны, и любые объекты std::condition_variable_any, ожидающие связанных std::stop_token(ов), будут разбужены.

После запроса на остановку его нельзя отозвать. Дополнительные запросы на остановку не имеют эффекта.

Члены-функции

(конструктор)	создаёт новый объект `stop_source` (публичный член-функция)
(деструктор)	удаляет объект `stop_source` (публичный член-функция)
operator=	присваивает объект `stop_source` (публичный член-функция)
Модификаторы
request_stop	делает запрос на остановку для связанного состояния остановки, если таковое имеется (публичный член-функция)
swap	меняет местами два объекта `stop_source` (публичный член-функция)
Наблюдатели
get_token	возвращает токен `stop_token` для связанного состояния остановки (публичный член-функция)
stop_requested	проверяет, был ли запрос на остановку связанного состояния остановки (публичный член-функция)
stop_possible	проверяет, можно ли запросить остановку связанного состояния остановки (публичный член-функция)

Функции, не являющиеся членами класса

operator==	сравнивает два объекта `std::stop_source` (функция)
swap(std::stop_source) (C++20)	специализирует алгоритм `std::swap` (функция)

Вспомогательные константы

nostopstate

(C++20)

экземпляр std::nostopstate_t для использования в конструкторе stop_source
(константа)

Вспомогательные классы

nostopstate_t

(C++20)

тип-заполнитель для использования в конструкторе stop_source
(класс)

Примечания

Для целей отмены std::jthread объект stop_source должен быть получен из объекта std::jthread с помощью get_stop_source(); или запрос на остановку должен быть сделан непосредственно из объекта std::jthread с помощью request_stop(). Это затем будет использовать то же связанное состояние остановки, что и то, которое было передано в аргумент вызываемой функции std::jthread (т. е. функции, выполняемой в её потоке).

Однако для других целей объект stop_source может быть создан отдельно с помощью конструктора по умолчанию, который создаёт новое состояние остановки.

Макрос проверки наличия функции	Значение	Std	Функция
`__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_source stop_source)
{
    std::stop_token stoken = stop_source.get_token();
    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);
 
    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

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