Scroll to navigation

std::stop_token(3cxx) std::stop_token(3cxx)

NAME

std::stop_token - Allow testing whether a stop request has been made on a stop_source.

SYNOPSIS

Public Member Functions


stop_token (const stop_token &) noexcept=default
stop_token (stop_token &&) noexcept=default
stop_token & operator= (const stop_token &) noexcept=default
stop_token & operator= (stop_token &&) noexcept=default
bool stop_possible () const noexcept
bool stop_requested () const noexcept
void swap (stop_token &__rhs) noexcept

Friends


bool operator== (const stop_token &__a, const stop_token &__b)
template<typename _Callback > class stop_callback
class stop_source
void swap (stop_token &__lhs, stop_token &__rhs) noexcept

Detailed Description

Allow testing whether a stop request has been made on a stop_source.

Definition at line 52 of file stop_token.

Member Function Documentation

bool std::stop_token::stop_possible () const [inline], [noexcept]

Definition at line 70 of file stop_token.

bool std::stop_token::stop_requested () const [inline], [noexcept]

Definition at line 77 of file stop_token.

void std::stop_token::swap (stop_token & __rhs) [inline], [noexcept]

Definition at line 83 of file stop_token.

Friends And Related Function Documentation

bool operator== (const stop_token & __a, const stop_token & __b) [friend]

Definition at line 88 of file stop_token.

template<typename _Callback > friend class stop_callback [friend]

Definition at line 98 of file stop_token.

friend class stop_source [friend]

Definition at line 96 of file stop_token.

void swap (stop_token & __lhs, stop_token & __rhs) [friend]

Definition at line 92 of file stop_token.

Author

Generated automatically by Doxygen for libstdc++ from the source code.

Mon Aug 22 2022 libstdc++