[#CThreadInterrupt-sleep_for]
= xref:CThreadInterrupt.adoc[CThreadInterrupt]::sleep_for
:relfileprefix: ../
:mrdocs:

Sleep for the given duration, returning early if interrupted.

== Synopsis

Declared in `<util/threadinterrupt.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[requires_capability(0x7fb985419fb8), requires_capability(0x7fb97abaa8a8), requires_capability(0x7fb96e0e6f48), requires_capability(0x7fb96e60e4d8), requires_capability(0x7fb966192658), requires_capability(0x7fb96a0aa948), requires_capability(0x7fb975ceb828), requires_capability(0x7fb97f0fd8d8), requires_capability(0x7fb97a9cf0b8), requires_capability(0x7fb97fda39c8), requires_capability(0x7fb97f2702d8), requires_capability(0x7fb967b38bc8), requires_capability(0x7fb968706378), requires_capability(0x7fb9787106f8), requires_capability(0x7fb96b0e31b8), requires_capability(0x7fb975f46db8), requires_capability(0x7fb97b308ca8), requires_capability(0x7fb96406a9f8), requires_capability(0x7fb9605fa908), requires_capability(0x7fb956618558), requires_capability(0x7fb979507b18), requires_capability(0x7fb976b96e68), requires_capability(0x7fb974cd0cd8)]]
virtual
bool
sleep_for(Clock::duration rel_time);
----

== Return Value

true if the full duration elapsed, false if the sleep was interrupted.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *rel_time*
| The duration to sleep for.
|===


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