ICondition.Await Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Await() |
Causes the current thread to wait until it is signalled or Thread#interrupt interrupted. |
| Await(Int64, TimeUnit) |
Causes the current thread to wait until it is signalled or interrupted, or the specified waiting time elapses. |
Await()
Causes the current thread to wait until it is signalled or Thread#interrupt interrupted.
[Android.Runtime.Register("await", "()V", "GetAwaitHandler:Java.Util.Concurrent.Locks.IConditionInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]
public void Await ();[<Android.Runtime.Register("await", "()V", "GetAwaitHandler:Java.Util.Concurrent.Locks.IConditionInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]
abstract member Await : unit -> unit- Attributes
Exceptions
if the current thread is interrupted (and interruption of thread suspension is supported)
Remarks
Causes the current thread to wait until it is signalled or Thread#interrupt interrupted.
The lock associated with this Condition is atomically released and the current thread becomes disabled for thread scheduling purposes and lies dormant until <em>one</em> of four things happens: <ul> <li>Some other thread invokes the #signal method for this Condition and the current thread happens to be chosen as the thread to be awakened; or <li>Some other thread invokes the #signalAll method for this Condition; or <li>Some other thread Thread#interrupt interrupts the current thread, and interruption of thread suspension is supported; or <li>A "<em>spurious wakeup</em>" occurs. </ul>
In all cases, before this method can return the current thread must re-acquire the lock associated with this condition. When the thread returns it is <em>guaranteed</em> to hold this lock.
If the current thread: <ul> <li>has its interrupted status set on entry to this method; or <li>is Thread#interrupt interrupted while waiting and interruption of thread suspension is supported, </ul> then InterruptedException is thrown and the current thread's interrupted status is cleared. It is not specified, in the first case, whether or not the test for interruption occurs before the lock is released.
<b>Implementation Considerations</b>
The current thread is assumed to hold the lock associated with this Condition when this method is called. It is up to the implementation to determine if this is the case and if not, how to respond. Typically, an exception will be thrown (such as IllegalMonitorStateException) and the implementation must document that fact.
An implementation can favor responding to an interrupt over normal method return in response to a signal. In that case the implementation must ensure that the signal is redirected to another waiting thread, if there is one.
Java documentation for java.util.concurrent.locks.Condition.await().
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Applies to
Await(Int64, TimeUnit)
Causes the current thread to wait until it is signalled or interrupted, or the specified waiting time elapses.
[Android.Runtime.Register("await", "(JLjava/util/concurrent/TimeUnit;)Z", "GetAwait_JLjava_util_concurrent_TimeUnit_Handler:Java.Util.Concurrent.Locks.IConditionInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]
public bool Await (long time, Java.Util.Concurrent.TimeUnit? unit);[<Android.Runtime.Register("await", "(JLjava/util/concurrent/TimeUnit;)Z", "GetAwait_JLjava_util_concurrent_TimeUnit_Handler:Java.Util.Concurrent.Locks.IConditionInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]
abstract member Await : int64 * Java.Util.Concurrent.TimeUnit -> boolParameters
- time
- Int64
the maximum time to wait
- unit
- TimeUnit
the time unit of the time argument
Returns
false if the waiting time detectably elapsed
before return from the method, else true
- Attributes
Exceptions
if the current thread is interrupted (and interruption of thread suspension is supported)
Remarks
Causes the current thread to wait until it is signalled or interrupted, or the specified waiting time elapses. This method is behaviorally equivalent to:
{@code awaitNanos(unit.toNanos(time)) > 0}
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.