Scroll to navigation

std::stop_source(3cxx) std::stop_source(3cxx)

NAME

std::stop_source - A type that allows a stop request to be made.

SYNOPSIS

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 477 of file stop_token.

Constructor & Destructor Documentation

std::stop_source::stop_source () [inline]

Definition at line 480 of file stop_token.

std::stop_source::stop_source (std::nostopstate_t) [inline], [explicit], [noexcept]

Definition at line 483 of file stop_token.

std::stop_source::stop_source (const stop_source & __other) [inline], [noexcept]

Definition at line 486 of file stop_token.

std::stop_source::~stop_source () [inline]

Definition at line 511 of file stop_token.

Member Function Documentation

stop_token std::stop_source::get_token () const [inline], [noexcept]

Definition at line 541 of file stop_token.

stop_source & std::stop_source::operator= (const stop_source & __other) [inline], [noexcept]

Definition at line 496 of file stop_token.

bool std::stop_source::request_stop () const [inline], [noexcept]

Definition at line 532 of file stop_token.

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

Definition at line 519 of file stop_token.

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

Definition at line 526 of file stop_token.

void std::stop_source::swap (stop_source & __other) [inline], [noexcept]

Definition at line 547 of file stop_token.

Friends And Related Function Documentation

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

Definition at line 554 of file stop_token.

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

Definition at line 560 of file stop_token.

Author

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

Sun Jan 8 2023 libstdc++