[#bsl-stop_token-stop_requested]
= xref:bsl.adoc[bsl]::xref:bsl/stop_token.adoc[stop&lowbar;token]::stop&lowbar;requested
:relfileprefix: ../../
:mrdocs:

Return `true` if `&ast;this` refers to a stop state on which `request&lowbar;stop` has been called, and `false` otherwise&period; If this function returns `true`, then the successful call to `request&lowbar;stop` synchronizes with this call&period; A call to `stop&lowbar;requested` that is potentially concurrent with a call to `stop&lowbar;requested` or `stop&lowbar;possible` does not cause a data race&period;

== Synopsis

Declared in `&lt;bslstl&lowbar;stoptoken&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
&lsqb;&lsqb;nodiscard&rsqb;&rsqb;
bool
stop&lowbar;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]#
