std::stop_source::request_stop

 

哋它亢++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (哋它亢++20)

Language support library

Concepts library (哋它亢++20)

Metaprogramming library (哋它亢++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (哋它亢++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (哋它亢++17)

Regular expressions library (哋它亢++11)

Concurrency support library (哋它亢++11)

Technical specifications

Symbols index

External libraries

 

Concurrency support library

Threads thread (哋它亢++11) jthread (哋它亢++20) stop_token (哋它亢++20) stop_source (哋它亢++20) stop_callback (哋它亢++20) hardware_destructive_interference_sizehardware_constructive_interference_size (哋它亢++17)(哋它亢++17) this_thread namespace get_id (哋它亢++11) yield (哋它亢++11) sleep_for (哋它亢++11) sleep_until (哋它亢++11) Mutual exclusion mutex (哋它亢++11) recursive_mutex (哋它亢++11)   shared_mutex (哋它亢++17) timed_mutex (哋它亢++11) recursive_timed_mutex (哋它亢++11)     shared_timed_mutex (哋它亢++14) Generic lock management lock_guard (哋它亢++11) scoped_lock (哋它亢++17) unique_lock (哋它亢++11) shared_lock (哋它亢++14) defer_lock_ttry_to_lock_tadopt_lock_t (哋它亢++11)(哋它亢++11)(哋它亢++11) lock (哋它亢++11) try_lock (哋它亢++11) defer_locktry_to_lockadopt_lock (哋它亢++11)(哋它亢++11)(哋它亢++11) once_flag (哋它亢++11) call_once (哋它亢++11) Condition variables condition_variable (哋它亢++11) condition_variable_any (哋它亢++11) notify_all_at_thread_exit (哋它亢++11) cv_status (哋它亢++11) Semaphores counting_semaphorebinary_semaphore (哋它亢++20)(哋它亢++20) Latches and Barriers latch (哋它亢++20) barrier (哋它亢++20) Futures promise (哋它亢++11) future (哋它亢++11) shared_future (哋它亢++11) packaged_task (哋它亢++11) async (哋它亢++11) launch (哋它亢++11) future_status (哋它亢++11) future_error (哋它亢++11) future_category (哋它亢++11) future_errc (哋它亢++11) Safe Reclamation rcu_obj_base (哋它亢++26) rcu_domain (哋它亢++26) rcu_default_domain (哋它亢++26)   rcu_synchronize (哋它亢++26) rcu_barrier (哋它亢++26) rcu_retire (哋它亢++26) Hazard Pointers hazard_pointer_obj_base (哋它亢++26) hazard_pointer (哋它亢++26) make_hazard_pointer (哋它亢++26)

Atomic types atomic (哋它亢++11) atomic_ref (哋它亢++20) atomic_flag (哋它亢++11) Initialization of atomic types atomic_init (哋它亢++11)(deprecated in 哋它亢++20) ATOMIC_VAR_INIT (哋它亢++11)(deprecated in 哋它亢++20) ATOMIC_FLAG_INIT (哋它亢++11) Memory ordering memory_order (哋它亢++11) kill_dependency (哋它亢++11) atomic_thread_fence (哋它亢++11) atomic_signal_fence (哋它亢++11) Free functions for atomic operations atomic_storeatomic_store_explicit (哋它亢++11)(哋它亢++11) atomic_loadatomic_load_explicit (哋它亢++11)(哋它亢++11) atomic_exchangeatomic_exchange_explicit (哋它亢++11)(哋它亢++11) atomic_compare_exchange_weakatomic_compare_exchange_weak_explicitatomic_compare_exchange_strongatomic_compare_exchange_strong_explicit (哋它亢++11)(哋它亢++11)(哋它亢++11)(哋它亢++11) atomic_fetch_addatomic_fetch_add_explicit (哋它亢++11)(哋它亢++11) atomic_fetch_subatomic_fetch_sub_explicit (哋它亢++11)(哋它亢++11) atomic_fetch_andatomic_fetch_and_explicit (哋它亢++11)(哋它亢++11) atomic_fetch_oratomic_fetch_or_explicit (哋它亢++11)(哋它亢++11) atomic_fetch_xoratomic_fetch_xor_explicit (哋它亢++11)(哋它亢++11) atomic_fetch_maxatomic_fetch_max_explicit (哋它亢++26)(哋它亢++26) atomic_fetch_minatomic_fetch_min_explicit (哋它亢++26)(哋它亢++26) atomic_is_lock_free (哋它亢++11) atomic_waitatomic_wait_explicit (哋它亢++20)(哋它亢++20) atomic_notify_one (哋它亢++20) atomic_notify_all (哋它亢++20) Free functions for atomic flags atomic_flag_test_and_setatomic_flag_test_and_set_explicit (哋它亢++11)(哋它亢++11) atomic_flag_clearatomic_flag_clear_explicit (哋它亢++11)(哋它亢++11) atomic_flag_testatomic_flag_test_explicit (哋它亢++20)(哋它亢++20) atomic_flag_waitatomic_flag_wait_explicit (哋它亢++20)(哋它亢++20) atomic_flag_notify_one (哋它亢++20) atomic_flag_notify_all (哋它亢++20)

 

std::stop_source

Member functions

stop_source::stop_source

stop_source::~stop_source

stop_source::operator=

Modifiers

stop_source::request_stop

stop_source::swap

Observers

stop_source::get_token

stop_source::stop_requested

stop_source::stop_possible

Non-member functions

swap(std::stop_source)

operator==

Helper constants

std::nostopstate

Helper classes

std::nostopstate_t

 

bool request_stop() noexcept;		(since 哋它亢++20)

Issues a stop request to the stop-state, if the stop_source object has a stop-state and it has not yet already had stop requested.

The determination is made atomically, and if stop was requested, the stop-state is atomically updated to avoid race conditions, such that:

• stop_requested() and stop_possible() can be concurrently invoked on other stop_tokens and stop_sources of the same stop-state;
• request_stop() can be concurrently invoked on other stop_source objects, and only one will actually perform the stop request.

However, see the Notes section.

Parameters

(none)

Return value

true if the stop_source object has a stop-state and this invocation made a stop request, otherwise false.

Postconditions

stop_possible() is false or stop_requested() is true.

Notes

If the request_stop() does issue a stop request (i.e., returns true), then any stop_callbacks registered for the same associated stop-state will be invoked synchronously, on the same thread request_stop() is issued on. If an invocation of a callback exits via an exception, std::terminate is called.

If the stop_source object has a stop-state but a stop request has already been made, this function returns false. However there is no guarantee that another stop_source object which has just (successfully) requested stop is not still in the middle of invoking a stop_callback function.

If the request_stop() does issue a stop request (i.e., returns true), then all condition variables of base type std::condition_variable_any registered with an interruptible wait for stop_tokens associated with the stop_source's stop-state will be notified.