[#BloombergLP-bslstl-StopState]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslstl.adoc[bslstl]::StopState
:relfileprefix: ../../
:mrdocs:

Shared stop state that tracks a stop request and registered callbacks.

== Synopsis

Declared in `<bslstl_stopstate.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class StopState;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslstl/StopState/2constructor-00.adoc[`StopState`]         [.small]#[constructor]#
| Create a `StopState` object that initially has no registered callbacks and on which a stop has not been requested.
| xref:BloombergLP/bslstl/StopState/deregister.adoc[`deregister`] 
| Remove `node` from this stop state, or wait if its callback is executing.
| xref:BloombergLP/bslstl/StopState/enregister.adoc[`enregister`] 
| Register `node` with this stop state, or invoke it if a stop was already requested.
| xref:BloombergLP/bslstl/StopState/requestStop.adoc[`requestStop`] 
| Request a stop on this state and invoke all registered callbacks.
| xref:BloombergLP/bslstl/StopState/stopRequested.adoc[`stopRequested`] 
| Return `true` if a stop has been requested on this `StopState` object, and `false` otherwise.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslstl/StopToken_RefCountedState.adoc[`StopToken_RefCountedState`] 
| Component‐private `StopState` with a `stop_source` reference count.
|===


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