[#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(0x7ff3790f66b8), requires_capability(0x7ff378192cb8), requires_capability(0x7ff36e339ca8), requires_capability(0x7ff38ac0d378), requires_capability(0x7ff37dfbfa68), requires_capability(0x7ff37611c618), requires_capability(0x7ff37f82a2e8), requires_capability(0x7ff378d28dc8), requires_capability(0x7ff380247538), requires_capability(0x7ff35c4d93d8), requires_capability(0x7ff38a7f4bc8), requires_capability(0x7ff38fae79c8), requires_capability(0x7ff38efb9028), requires_capability(0x7ff37fd79658), requires_capability(0x7ff38c64f908), requires_capability(0x7ff36e7de5a8), requires_capability(0x7ff3773e36d8), requires_capability(0x7ff36e79e598), requires_capability(0x7ff3922da908), requires_capability(0x7ff37c292258), requires_capability(0x7ff3805d1e78), requires_capability(0x7ff37463f2e8), requires_capability(0x7ff37526ebf8)]]
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]#