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== (C++20)	сравнивает два объекта `std::stop_source` (функция)
swap(std::stop_source) (C++20)	специализирует алгоритм `std::swap` (функция)

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

nostopstatenostopstate_t

(C++20)

тег, используемый для stop_source, указывающий, что при создании связанное состояние остановки отсутствует
(тег)

Примечания

Для отмены std::jthread объект stop_source следует получить из объекта std::jthread с помощью get_stop_source(); либо запрос на остановку следует отправить непосредственно объекту std::jthread с помощью request_stop(). В этом случае будет использовано то же связанное состояние остановки, которое передаётся в качестве аргумента вызываемой функции 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

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