[#BloombergLP-bslmt-Sluice-timedWait-09]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslmt.adoc[bslmt]::xref:BloombergLP/bslmt/Sluice.adoc[Sluice]::timedWait
:relfileprefix: ../../../
:mrdocs:

Wait for `token` to be signaled, or until `absTime` expires.

== Synopsis

Declared in `<bslmt_sluice.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
timedWait(
    void const* token,
    xref:BloombergLP/bsls/TimeInterval.adoc[bsls::TimeInterval] const& absTime);
----

== Description

Wait for the specified `token` to be signaled, or until the specified `absTime` timeout expires. `absTime` is an _absolute_ time represented as an interval from some epoch, which is determined by the clock indicated at construction (see {Supported Clock‐Types} in the component‐level documentation). Return 0 on success, and `e_TIMED_OUT` on timeout. Any other value indicates that an error has occurred. Errors are unrecoverable. After an error, the sluice may be destroyed, but any other use has undefined behavior. The `token` is released whether or not a timeout occurred. The behavior is undefined unless `token` was obtained from a call to `enter` by this thread, and was not subsequently released (via a call to `timedWait` or `wait`).

== Return Value

0 on success, `e_TIMED_OUT` on timeout, or another value on error

== Parameters

[cols="1,4"]
|===
| Name| Description
| *token*
| wait token previously returned by `enter`
| *absTime*
| absolute timeout from the construction clock epoch
|===


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