std::stop_callback

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

Шаблон класса stop_callback предоставляет тип объекта RAII, который регистрирует функцию обратного вызова для связанного объекта std::stop_token, так что функция обратного вызова будет вызвана, когда связанный с std::stop_token объект std::stop_source запросит остановку.

Функции обратного вызова, зарегистрированные через конструктор stop_callback, вызываются либо в том же потоке, который успешно вызывает request_stop() для std::stop_source связанного с stop_callback std::stop_token; или, если остановка уже запрошена до регистрации конструктора, то обратный вызов вызывается в потоке, создающем stop_callback.

Можно создать несколько stop_callback для одного и того же std::stop_token, из одного или разных потоков одновременно. Гарантии порядка их выполнения не предоставляется, но они будут вызваны синхронно; за исключением stop_callback(ов), созданных после того, как остановка уже была запрошена для std::stop_token, как описано ранее.

Если вызов обратного вызова завершается исключением, то вызывается std::terminate.

std::stop_callback не является CopyConstructible, CopyAssignable, MoveConstructible, ни MoveAssignable.

Тип шаблона параметра Callback должен быть одновременно invocable и destructible. Любое возвращаемое значение игнорируется.

Типы членов

Тип	Определение
`callback_type`	`Callback`

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

(конструктор)	создает новый объект `stop_callback` (публичная функция-член)
(деструктор)	уничтожает объект `stop_callback` (публичная функция-член)
operator= [удалено]	`stop_callback` не может быть присвоено (публичная функция-член)

Руководства по выводу типов

Пример

#include <chrono>
#include <condition_variable>
#include <iostream>
#include <mutex>
#include <sstream>
#include <thread>
 
using namespace std::chrono_literals;
 
// Use a helper class for atomic std::cout streaming.
class Writer
{
    std::ostringstream buffer;
public:
    ~Writer()
    {
        std::cout << buffer.str();
    }
    Writer& operator<<(auto input)
    {
        buffer << input;
        return *this;
    }
};
 
int main()
{
    // A worker thread.
    // It will wait until it is requested to stop.
    std::jthread worker([] (std::stop_token stoken)
    {
        Writer() << "Worker thread's id: " << std::this_thread::get_id() << '\n';
        std::mutex mutex;
        std::unique_lock lock(mutex);
        std::condition_variable_any().wait(lock, stoken,
            [&stoken] { return stoken.stop_requested(); });
    });
 
    // Register a stop callback on the worker thread.
    std::stop_callback callback(worker.get_stop_token(), []
    {
        Writer() << "Stop callback executed by thread: "
            << std::this_thread::get_id() << '\n';
    });
 
    // Stop_callback objects can be destroyed prematurely to prevent execution.
    {
        std::stop_callback scoped_callback(worker.get_stop_token(), []
        {
            // This will not be executed.
            Writer() << "Scoped stop callback executed by thread: "
                << std::this_thread::get_id() << '\n';
        });
    }
 
    // Demonstrate which thread executes the stop_callback and when.
    // Define a stopper function.
    auto stopper_func = [&worker]
    {
        if (worker.request_stop())
            Writer() << "Stop request executed by thread: "
                << std::this_thread::get_id() << '\n';
        else
            Writer() << "Stop request not executed by thread: "
                << std::this_thread::get_id() << '\n';
    };
 
    // Let multiple threads compete for stopping the worker thread.
    std::jthread stopper1(stopper_func);
    std::jthread stopper2(stopper_func);
    stopper1.join();
    stopper2.join();
 
    // After a stop has already been requested,
    // a new stop_callback executes immediately.
    Writer() << "Main thread: " << std::this_thread::get_id() << '\n';
    std::stop_callback callback_after_stop(worker.get_stop_token(), []
    {
        Writer() << "Stop callback executed by thread: "
            << std::this_thread::get_id() << '\n';
    });
}

Возможный вывод:

Worker thread's id: 140460265039616
Stop callback executed by thread: 140460256646912
Stop request executed by thread: 140460256646912
Stop request not executed by thread: 140460248254208
Main thread: 140460265043776
Stop callback executed by thread: 140460265043776

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