std::stop_source

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Thread support library

Threads
thread (C++11)
jthread (C++20)
stop_token (C++20)
stop_source (C++20)
stop_callback (C++20)
hardware_destructive_interference_sizehardware_constructive_interference_size (C++17)(C++17)
this_thread namespace
get_id (C++11) yield (C++11)	sleep_for (C++11) sleep_until (C++11)
Mutual exclusion
mutex (C++11) recursive_mutex (C++11) shared_mutex (C++17)	timed_mutex (C++11) recursive_timed_mutex (C++11) shared_timed_mutex (C++14)
Generic lock management
lock_guard (C++11) scoped_lock (C++17) unique_lock (C++11) shared_lock (C++14) defer_lock_ttry_to_lock_tadopt_lock_t (C++11)(C++11)(C++11)	lock (C++11) try_lock (C++11) defer_locktry_to_lockadopt_lock (C++11)(C++11)(C++11) once_flag (C++11) call_once (C++11)
Condition variables
condition_variable (C++11)
condition_variable_any (C++11)
notify_all_at_thread_exit (C++11)
cv_status (C++11)
Semaphores
counting_semaphorebinary_semaphore (C++20)(C++20)
Latches and barriers
latch (C++20)
barrier (C++20)
Futures
promise (C++11) future (C++11) shared_future (C++11) packaged_task (C++11) async (C++11)	launch (C++11) future_status (C++11) future_error (C++11) future_category (C++11) future_errc (C++11)

 

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

 

Defined in header <stop_token>
class stop_source;		(since C++20)

The stop_source class provides the means to issue a stop request, such as for std::jthread cancellation. A stop request made for one stop_source object is visible to all stop_sources and std::stop_tokens of the same associated stop-state; any std::stop_callback(s) registered for associated std::stop_token(s) will be invoked, and any std::condition_variable_any objects waiting on associated std::stop_token(s) will be awoken.

Once a stop is requested, it cannot be withdrawn. Additional stop requests have no effect.

Member functions

(constructor)	constructs new stop_source object (public member function)
(destructor)	destructs the stop_source object (public member function)
operator=	assigns the stop_source object (public member function)
Modifiers
request_stop	makes a stop request for the associated stop-state, if any (public member function)
swap	swaps two stop_source objects (public member function)
Observers
get_token	returns a stop_token for the associated stop-state (public member function)
stop_requested	checks whether the associated stop-state has been requested to stop (public member function)
stop_possible	checks whether associated stop-state can be requested to stop (public member function)

Non-member functions

operator==	compares two std::stop_source objects (function)
swap(std::stop_source) (C++20)	specializes the std::swap algorithm (function)

Helper constants

nostopstate (C++20)

a std::nostopstate_t instance for use in stop_source constructor (constant)

Helper classes

nostopstate_t (C++20)

placeholder type for use in stop_source constructor (class)

Notes

For the purposes of std::jthread cancellation the stop_source object should be retrieved from the std::jthread object using get_stop_source(); or stop should be requested directly from the std::jthread object using request_stop(). This will then use the same associated stop-state as that passed into the std::jthread's invoked function argument (i.e., the function being executed on its thread).

For other uses, however, a stop_source can be constructed separately using the default constructor, which creates new stop-state.