[#bsl-stop_source-stop_requested]
= xref:bsl.adoc[bsl]::xref:bsl/stop_source.adoc[stop_source]::stop_requested
:relfileprefix: ../../
:mrdocs:

Return `true` if `*this` refers to a stop state on which `request_stop` has been called, and `false` otherwise. If this function returns `true`, then the successful call to `request_stop` synchronizes with this call. A call to `stop_requested` that is potentially concurrent with a call to `stop_requested`, `stop_possible`, or `request_stop` does not cause a data race.

== Synopsis

Declared in `<bslstl_stoptoken.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
bool
stop_requested() const noexcept;
----

== Return Value

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====

[.small]#Created with https://www.mrdocs.com[MrDocs]#