[#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(0x7f2e18c12e38), requires_capability(0x7f2e32718518), requires_capability(0x7f2e2a301618), requires_capability(0x7f2e37b29708), requires_capability(0x7f2e22088d28), requires_capability(0x7f2e25f35aa8), requires_capability(0x7f2e42e837f8), requires_capability(0x7f2e225a5378), requires_capability(0x7f2e36bf5ed8), requires_capability(0x7f2e2253cd58), requires_capability(0x7f2e2390ccd8), requires_capability(0x7f2e1be63c88), requires_capability(0x7f2e188a4e68), requires_capability(0x7f2e285830a8), requires_capability(0x7f2e26d325f8), requires_capability(0x7f2e1d2cbdf8), requires_capability(0x7f2e08467cd8), requires_capability(0x7f2e1c59e9e8), requires_capability(0x7f2e38a13698), requires_capability(0x7f2e3302aa88), requires_capability(0x7f2e2392c8b8), requires_capability(0x7f2e35bed0e8), requires_capability(0x7f2e1e8add88)]]
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]#