[#util-SignalInterrupt-wait]
= xref:util.adoc[util]::xref:util/SignalInterrupt.adoc[SignalInterrupt]::wait
:relfileprefix: ../../
:mrdocs:

Blocks until an interrupt is requested.

== Synopsis

Declared in `<util/signalinterrupt.h>`

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

== Return Value

true once interrupted, false on error

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

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