std::stop_token::stop_possible
| bool stop_possible() const noexcept; |
(seit C++20) | |
Prüft, ob das stop_token Objekt einen zugeordneten Stopp-Status hat und ob dieser Status entweder bereits eine Stopp-Anforderung erhalten hat oder zugeordnete std::stop_source Objekte besitzt.
Ein standardkonstruiertes stop_token hat keinen zugeordneten Stopp-Status und kann daher nicht gestoppt werden; der zugeordnete Stopp-Status, für den keine std::stop_source Objekte existieren, kann ebenfalls nicht gestoppt werden, wenn keine solche Anforderung bereits gestellt wurde.
Inhalt |
[bearbeiten] Parameter
(keine)
[bearbeiten] Rückgabewert
false, wenn das stop_token Objekt keinen zugeordneten Stopp-Status hat, oder es noch keine Stopp-Anforderung erhalten hat und keine zugeordneten std::stop_source Objekte besitzt; andernfalls true.
[bearbeiten] Anmerkungen
Wenn das stop_token Objekt einen zugeordneten Stopp-Status hat und bereits eine Stopp-Anforderung gestellt wurde, gibt diese Funktion immer noch true zurück.
Wenn das stop_token Objekt einen zugeordneten Stopp-Status von einem std::jthread hat – zum Beispiel, wenn das stop_token durch Aufruf von get_stop_token() auf einem std::jthread Objekt abgerufen wurde –, dann gibt diese Funktion immer true zurück. Ein std::jthread hat immer ein internes std::stop_source Objekt, auch wenn die aufrufende Funktion des Threads es nicht überprüft.
[bearbeiten] 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() ); }; // A worker thread that will listen to stop requests 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"; } }); // A worker thread that will only stop when completed 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); }
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
