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

Return whether this source currently refers to a stop state.

== Synopsis

Declared in `<bslstl_stoptoken.h>`

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

== Description

Return `true` if `*this` refers to a stop state, and `false` otherwise. A call to `stop_possible` that is potentially concurrent with a call to `stop_requested`, `stop_possible`, or `request_stop` does not cause a data race.

== Return Value

`true` if this source refers to a stop state

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

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