std::stop_token:: stop_possible

Prüft, ob das stop_token Objekt einen assoziierten Stop-Zustand besitzt, und ob dieser Zustand entweder bereits eine Stop-Anforderung erhalten hat oder assoziierte std::stop_source Objekt(e) vorhanden sind.

Ein standardmäßig konstruierter stop_token hat keinen zugeordneten Stop-Zustand und kann daher nicht gestoppt werden; der zugeordnete Stop-Zustand, für den kein std::stop_source Objekt existiert, kann ebenfalls nicht gestoppt werden, falls eine solche Anforderung nicht bereits gestellt wurde.

Parameter

(keine)

Rückgabewert

false falls das stop_token -Objekt keinen assoziierten Stop-Zustand besitzt, oder noch keine Stop-Anforderung erhalten hat und keine assoziierten std::stop_source -Objekte vorhanden sind; true andernfalls.

Hinweise

Wenn das stop_token -Objekt assoziierten Stop-Zustand hat und bereits eine Stop-Anforderung gestellt wurde, gibt diese Funktion weiterhin true zurück.

Wenn das stop_token -Objekt assoziierten Stop-Zustand von einem std::jthread besitzt – beispielsweise wurde das stop_token durch Aufruf von get_stop_token ( ) auf einem std::jthread -Objekt abgerufen – dann gibt diese Funktion stets true zurück. Ein std::jthread besitzt immer ein internes std::stop_source -Objekt, selbst wenn die aufgerufene Funktion des Threads dies nicht prüft.

Beispiel

#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()
        );
    };
    // Ein Worker-Thread, der auf Stop-Anforderungen hört
    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";
        }
    });
    // Ein Worker-Thread, der nur stoppt, wenn er fertig ist
    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