std::stop_token:: stop_possible

Vérifie si l'objet stop_token a un état d'arrêt associé, et que cet état a déjà reçu une demande d'arrêt ou qu'il possède des objets std::stop_source associés.

Un stop_token construit par défaut n'a pas d'état d'arrêt associé, et ne peut donc pas être arrêté ; l'état d'arrêt associé pour lequel aucun objet std::stop_source n'existe ne peut pas non plus être arrêté si une telle demande n'a pas déjà été faite.

Paramètres

(aucun)

Valeur de retour

false si l'objet stop_token n'a pas d'état d'arrêt associé, ou s'il n'a pas encore reçu de demande d'arrêt et qu'il n'y a pas d'objets std::stop_source associés ; true sinon.

Notes

Si l'objet stop_token a un état d'arrêt associé et qu'une demande d'arrêt a déjà été effectuée, cette fonction retourne toujours true .

Si l'objet stop_token possède un état d'arrêt associé provenant d'un std::jthread —par exemple, le stop_token a été obtenu en invoquant get_stop_token ( ) sur un objet std::jthread —alors cette fonction retourne toujours true . Un std::jthread possède toujours un objet interne std::stop_source , même si la fonction d'appel du thread ne le vérifie pas.

Exemple

#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()
        );
    };
    // Un thread travailleur qui écoutera les demandes d'arrêt
    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 << "  Le travailleur endormi est demandé d'arrêter\n";
                return;
            }
            std::cout << "  Le travailleur endormi retourne dormir\n";
        }
    });
    // Un thread travailleur qui s'arrêtera seulement quand il aura terminé
    auto inf_worker = std::jthread([]()
    {
        for (int i = 5; i; -- i)
        {
            std::this_thread::sleep_for(300ms);
            std::cout << "  Fonctionne aussi longtemps que nous le souhaitons\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 << "\nDemander et joindre stop_worker:\n";
    stop_worker.request_stop();
    stop_worker.join();
    std::cout << "\nDemander et joindre 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
Demander et joindre stop_worker:
  Fonctionne aussi longtemps que nous le souhaitons
  Le travailleur endormi est demandé d'arrêter
Demander et joindre inf_worker:
  Fonctionne aussi longtemps que nous le souhaitons
  Fonctionne aussi longtemps que nous le souhaitons
  Fonctionne aussi longtemps que nous le souhaitons
  Fonctionne aussi longtemps que nous le souhaitons
def_token : stop_possible = false, stop_requested = false
stop_token: stop_possible = true, stop_requested = true
inf_token : stop_possible = true, stop_requested = true