lock

abstract suspend fun lock(owner: Any? = null)

Locks this mutex, suspending caller while the mutex is locked.

This suspending function is cancellable. If the Job of the current coroutine is cancelled or completed while this function is suspended, this function immediately resumes with CancellationException. There is a prompt cancellation guarantee. If the job was cancelled while this function was suspended, it will not resume successfully. See suspendCancellableCoroutine documentation for low-level details. This function releases the lock if it was already acquired by this function before the CancellationException was thrown.

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 onLock clause. Use tryLock to try acquire lock without waiting.

This function is fair; suspended callers are resumed in first-in-first-out order.

Parameters

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.

Sources

common source
Link copied to clipboard