public Mutex
Mutual exclusion for coroutines.
Mutex has two states: locked and unlocked.
It is non-reentrant, that is invoking Mutex.lock even from the same thread/coroutine that currently holds
the lock still suspends the invoker.
Mutex.lock| Modifier and Type | Method and Description |
|---|---|
SelectClause2<java.lang.Object,kotlinx.coroutines.experimental.sync.Mutex> |
getOnLock()
Clause for select expression of
Mutex.lock suspending function that selects when the mutex is locked.
Additional parameter for the clause in the owner (see Mutex.lock) and when the clause is selected
the reference to this mutex is passed into the corresponding block. |
boolean |
holdsLock(java.lang.Object owner)
Checks mutex locked by owner
|
boolean |
isLocked()
Returns
true when this mutex is locked. |
java.lang.Object |
lock(java.lang.Object owner,
kotlin.coroutines.experimental.Continuation<? super kotlin.Unit> p)
Locks this mutex, suspending caller while the mutex is locked.
|
boolean |
tryLock(java.lang.Object owner)
Tries to lock this mutex, returning
false if this mutex is already locked. |
void |
unlock(java.lang.Object owner)
Unlocks this mutex. Throws IllegalStateException if invoked on a mutex that is not locked.
|
boolean isLocked()
Returns true when this mutex is locked.
boolean tryLock(java.lang.Object owner)
Tries to lock this mutex, returning false if this mutex is already locked.
owner - Optional owner token for debugging. When owner is specified (non-null value) and this mutex
is already locked with the same token (same identity), this function throws IllegalStateException.java.lang.Object lock(java.lang.Object owner,
kotlin.coroutines.experimental.Continuation<? super kotlin.Unit> p)
Locks this mutex, suspending caller while the mutex is locked.
This suspending function is cancellable. If the interface Job of the current coroutine is cancelled or completed while this
function is suspended, this function immediately resumes with CancellationException.
Cancellation of suspended lock invocation is atomic -- when this function throws CancellationException it means that the mutex was not locked. As a side-effect of atomic cancellation, a thread-bound coroutine (to some UI thread, for example) may continue to execute even after it was cancelled from the same thread in the case when this lock operation was already resumed and the continuation was posted for execution to the thread's queue.
Note, that this function does not check for cancellation when it is not suspended.
Use yield or CoroutineScope.isActive to periodically check for cancellation in tight loops if needed.
This function can be used in select invocation with Mutex.getOnLock clause.
Use Mutex.tryLock to try acquire lock without waiting.
owner - Optional owner token for debugging. When owner is specified (non-null value) and this mutex
is already locked with the same token (same identity), this function throws IllegalStateException.interface Job,
CoroutineScope.isActive,
Mutex.getOnLock,
Mutex.tryLockSelectClause2<java.lang.Object,kotlinx.coroutines.experimental.sync.Mutex> getOnLock()
Clause for select expression of Mutex.lock suspending function that selects when the mutex is locked.
Additional parameter for the clause in the owner (see Mutex.lock) and when the clause is selected
the reference to this mutex is passed into the corresponding block.
Mutex.lock,
Mutex.lockboolean holdsLock(java.lang.Object owner)
Checks mutex locked by owner
true on mutex lock by owner, false if not locker or it is locked by different ownervoid unlock(java.lang.Object owner)
Unlocks this mutex. Throws IllegalStateException if invoked on a mutex that is not locked.
owner - Optional owner token for debugging. When owner is specified (non-null value) and this mutex
was locked with the different token (by identity), this function throws IllegalStateException.