Namespaces
Variants

std::stop_token:: stop_requested

From cppreference.net
C++
Concurrency support library
Threads
(C++11)
(C++20)
(C++17) (C++17)
this_thread namespace
(C++11)
(C++11)
Cooperative cancellation
Mutual exclusion
Generic lock management
Condition variables
(C++11)
(C++11)
(C++11)
(C++11)
Semaphores
(C++20) (C++20)
Latches and Barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Safe reclamation
Hazard pointers
(C++26)
(C++26)
(C++26)
Atomic types
(C++11)
(C++20)
(C++11)
Initialization of atomic types
(C++11) (deprecated in C++20)
(C++11) (deprecated in C++20)
(C++11)
Memory ordering
(C++11)
(C++11) (deprecated in C++26)
(C++11)
(C++11)
Free functions for atomic operations
(C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11) (C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11)
(C++11) (C++11)
(C++26) (C++26)
(C++26) (C++26)
(C++11)
(C++20) (C++20)
(C++20)
(C++20)
Free functions for atomic flags
(C++11) (C++11)
(C++11) (C++11)
(C++20) (C++20)
(C++20) (C++20)
(C++20)
(C++20)
std::stop_token
bool stop_requested ( ) const noexcept ;
(C++20以降)

stop_token オブジェクトが関連付けられた停止状態を持ち、その状態が停止要求を受け取ったかどうかをチェックします。デフォルト構築された stop_token は関連付けられた停止状態を持たないため、停止要求は受け取っていません。

パラメータ

(なし)

戻り値

true は、 stop_token オブジェクトが関連付けられた停止状態を持ち、かつ停止要求を受信した場合に返されます。 false はそれ以外の場合に返されます。

例

このコードを実行 
#include <chrono>
#include <condition_variable>
#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 << name << ": stop_possible = " << token.stop_possible();
        std::cout << ", stop_requested = " << token.stop_requested() << '\n';
    };
    // 停止要求を監視するワーカースレッド
    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 << "  眠たいワーカーは停止を要求されました\n";
                return;
            }
            std::cout << "  眠たいワーカーは再び眠ります\n";
        }
    });
    // 完了時のみ停止するワーカースレッド
    auto inf_worker = std::jthread([]()
    {
        for (int i = 5; i; --i)
        {
            std::this_thread::sleep_for(300ms);
            std::cout << "  好きなだけ実行します\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 << "\nstop_workerの要求と結合:\n";
    stop_worker.request_stop();
    stop_worker.join();
    std::cout << "\ninf_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