Namensräume
Varianten
Aktionen

std::jthread::get_stop_token

Von cppreference.com
< cpp‎ | thread‎ | jthread
 
 
Bibliothek für nebenläufige Programmierung
Threads
(C++11)
(C++20)
this_thread Namespace
(C++11)
(C++11)
(C++11)
Kooperatives Beenden
Gegenseitiger Ausschluss
(C++11)
Allgemeines Sperrungsmanagement
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Bedingungsvariablen
(C++11)
Semaphoren
Latches und Barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
Sichere Wiederherstellung
(C++26)
Hazard Pointer
Atomare Typen
(C++11)
(C++20)
Initialisierung von atomaren Typen
(C++11)(veraltet in C++20)
(C++11)(veraltet in C++20)
Speicherordnung
(C++11)(deprecated in C++26)
Freie Funktionen für atomare Operationen
Freie Funktionen für atomare Flags
 
 
std::stop_token get_stop_token() const noexcept;
(seit C++20)

Gibt ein std::stop_token zurück, das mit demselben intern geteilten Stop-Zustand assoziiert ist wie das jthread-Objekt.

[bearbeiten] Parameter

(keine)

[bearbeiten] Rückgabewert

Ein Wert vom Typ std::stop_token, der mit dem intern vom jthread-Objekt gehaltenen Stop-Zustand assoziiert ist.

[bearbeiten] Beispiel

#include <chrono>
#include <condition_variable>
#include <iostream>
#include <mutex>
#include <string_view>
#include <thread>
 
using namespace std::chrono_literals;
 
void print(std::string_view name, const std::stop_token& token)
{
    std::cout << name << ": stop_possible = " << token.stop_possible();
    std::cout << ", stop_requested = " << token.stop_requested() << '\n';
}
 
void finite_sleepy(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";
    }
}
 
void infinite_sleepy()
{
    for (int i = 5; i; --i)
    {
        std::this_thread::sleep_for(300ms);
        std::cout << "  Run as long as we want\n";
    }
}
 
 
int main()
{
    std::cout << std::boolalpha;
 
    // A worker thread that will listen to stop requests
    std::jthread stop_worker(finite_sleepy);
 
    // A worker thread that will only stop when completed
    std::jthread inf_worker(infinite_sleepy);
 
    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);
}

Mögliche Ausgabe

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