BloombergLP::bslstl::StopCallback_NoAlloc

Synopsis

Declared in <bslstl_stoptoken.h>

class StopCallback_NoAlloc;

Friends

Name Description

bsl::stop_callback This class holds an object or reference of type t_CALLBACK and, when constructed using a stop_token that owns a stop state, schedules the held object or reference to be executed by the thread that requests cancellation on that stop state (if any). However, if cancellation was already requested before the stop_callback was constructed, the constructor invokes the callback immediately. If there is no stop state, or request_stop is never called for the stop state, then the callback is not invoked. stop_callback stores its callback within its own footprint, and thus never requires memory allocation; however, stop_callback<t_CALLBACK> is an allocator-aware class, if t_CALLBACK is an allocator-aware class, and any supplied allocator will then be passed to the constructor of t_CALLBACK.

Name	Description
`bsl::stop_callback`	This class holds an object or reference of type `t_CALLBACK` and, when constructed using a `stop_token` that owns a stop state, schedules the held object or reference to be executed by the thread that requests cancellation on that stop state (if any). However, if cancellation was already requested before the `stop_callback` was constructed, the constructor invokes the callback immediately. If there is no stop state, or `request_stop` is never called for the stop state, then the callback is not invoked. `stop_callback` stores its callback within its own footprint, and thus never requires memory allocation; however, `stop_callback<t_CALLBACK>` is an allocator-aware class, if `t_CALLBACK` is an allocator-aware class, and any supplied allocator will then be passed to the constructor of `t_CALLBACK`.