.TH "std::stop_token" 3cxx "Sun Jan 8 2023" "libstdc++" \" -*- nroff -*- .ad l .nh .SH NAME std::stop_token \- Allow testing whether a stop request has been made on a \fCstop_source\fP\&. .SH SYNOPSIS .br .PP .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBstop_token\fP (const \fBstop_token\fP &) noexcept=default" .br .ti -1c .RI "\fBstop_token\fP (\fBstop_token\fP &&) noexcept=default" .br .ti -1c .RI "\fBstop_token\fP & \fBoperator=\fP (const \fBstop_token\fP &) noexcept=default" .br .ti -1c .RI "\fBstop_token\fP & \fBoperator=\fP (\fBstop_token\fP &&) noexcept=default" .br .ti -1c .RI "bool \fBstop_possible\fP () const noexcept" .br .ti -1c .RI "bool \fBstop_requested\fP () const noexcept" .br .ti -1c .RI "void \fBswap\fP (\fBstop_token\fP &__rhs) noexcept" .br .in -1c .SS "Friends" .in +1c .ti -1c .RI "bool \fBoperator==\fP (const \fBstop_token\fP &__a, const \fBstop_token\fP &__b)" .br .ti -1c .RI "template class \fBstop_callback\fP" .br .ti -1c .RI "class \fBstop_source\fP" .br .ti -1c .RI "void \fBswap\fP (\fBstop_token\fP &__lhs, \fBstop_token\fP &__rhs) noexcept" .br .in -1c .SH "Detailed Description" .PP Allow testing whether a stop request has been made on a \fCstop_source\fP\&. .PP Definition at line \fB52\fP of file \fBstop_token\fP\&. .SH "Member Function Documentation" .PP .SS "bool std::stop_token::stop_possible () const\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB70\fP of file \fBstop_token\fP\&. .SS "bool std::stop_token::stop_requested () const\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB77\fP of file \fBstop_token\fP\&. .SS "void std::stop_token::swap (\fBstop_token\fP & __rhs)\fC [inline]\fP, \fC [noexcept]\fP" .PP Definition at line \fB83\fP of file \fBstop_token\fP\&. .SH "Friends And Related Function Documentation" .PP .SS "bool operator== (const \fBstop_token\fP & __a, const \fBstop_token\fP & __b)\fC [friend]\fP" .PP Definition at line \fB88\fP of file \fBstop_token\fP\&. .SS "template friend class \fBstop_callback\fP\fC [friend]\fP" .PP Definition at line \fB98\fP of file \fBstop_token\fP\&. .SS "friend class \fBstop_source\fP\fC [friend]\fP" .PP Definition at line \fB96\fP of file \fBstop_token\fP\&. .SS "void swap (\fBstop_token\fP & __lhs, \fBstop_token\fP & __rhs)\fC [friend]\fP" .PP Definition at line \fB92\fP of file \fBstop_token\fP\&. .SH "Author" .PP Generated automatically by Doxygen for libstdc++ from the source code\&.