libstdc++
Public Member Functions | Friends | List of all members
std::stop_source Class Reference

Public Member Functions

 stop_source (const stop_source &__other) noexcept
 
 stop_source (std::nostopstate_t) noexcept
 
 stop_source (stop_source &&) noexcept=default
 
stop_token get_token () const noexcept
 
stop_source & operator= (const stop_source &__other) noexcept
 
stop_source & operator= (stop_source &&) noexcept=default
 
bool request_stop () const noexcept
 
bool stop_possible () const noexcept
 
bool stop_requested () const noexcept
 
void swap (stop_source &__other) noexcept
 

Friends

bool operator== (const stop_source &__a, const stop_source &__b) noexcept
 
void swap (stop_source &__lhs, stop_source &__rhs) noexcept
 

Detailed Description

A type that allows a stop request to be made.

Definition at line 480 of file stop_token.

Constructor & Destructor Documentation

◆ stop_source() [1/3]

std::stop_source::stop_source ( )
inline

Definition at line 483 of file stop_token.

◆ stop_source() [2/3]

std::stop_source::stop_source ( std::nostopstate_t  )
inlineexplicitnoexcept

Definition at line 486 of file stop_token.

◆ stop_source() [3/3]

std::stop_source::stop_source ( const stop_source &  __other)
inlinenoexcept

Definition at line 489 of file stop_token.

◆ ~stop_source()

std::stop_source::~stop_source ( )
inline

Definition at line 514 of file stop_token.

Member Function Documentation

◆ get_token()

stop_token std::stop_source::get_token ( ) const
inlinenoexcept

Definition at line 544 of file stop_token.

◆ operator=()

stop_source & std::stop_source::operator= ( const stop_source &  __other)
inlinenoexcept

Definition at line 499 of file stop_token.

◆ request_stop()

bool std::stop_source::request_stop ( ) const
inlinenoexcept

Definition at line 535 of file stop_token.

◆ stop_possible()

bool std::stop_source::stop_possible ( ) const
inlinenoexcept

Definition at line 522 of file stop_token.

◆ stop_requested()

bool std::stop_source::stop_requested ( ) const
inlinenoexcept

Definition at line 529 of file stop_token.

◆ swap()

void std::stop_source::swap ( stop_source &  __other)
inlinenoexcept

Definition at line 550 of file stop_token.

Friends And Related Symbol Documentation

◆ operator==

bool operator== ( const stop_source &  __a,
const stop_source &  __b 
)
friend

Definition at line 557 of file stop_token.

◆ swap

void swap ( stop_source &  __lhs,
stop_source &  __rhs 
)
friend

Definition at line 563 of file stop_token.

The documentation for this class was generated from the following file: