std::stop_source
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
| constructs new stop_source object (public member function) |
|
| destructs the stop_source object (public member function) |
|
| assigns the stop_source object (public member function) |
|
Modifiers |
|
| makes a stop request for the associated stop-state, if any (public member function) |
|
| swaps two stop_source objects (public member function) |
|
Observers |
|
returns a stop_token for the associated stop-state (public member function) |
|
| checks whether the associated stop-state has been requested to stop (public member function) |
|
| checks whether associated stop-state can be requested to stop (public member function) |
|
Non-member functions
compares two std::stop_source objects (function) |
|
|
(C++20)
|
specializes the std::swap algorithm (function) |
Helper constants
|
(C++20)
|
a std::nostopstate_t instance for use in stop_source constructor (constant) |
Helper classes
|
(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.
Feature testing macro: __cpp_lib_jthread.
Example
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/thread/stop_source
