ktor-io/io.ktor.utils.io.locks/ReentrantLock

ReentrantLock

expect class ReentrantLock(source)

ReentrantLock from kotlinx.atomicfu.locks

ReentrantLock is designed for delegation. You write val lock = reentrantLock() to construct its instance and use lock/tryLock/unlock functions or lock.withLock { ... } extension function similarly to the way jucl.ReentrantLock is used on JVM. On JVM it is a typealias to the later class, erased on JS.

Report a problem

actual typealias ReentrantLock = java.util.concurrent.locks.ReentrantLock(source)

ReentrantLock from kotlinx.atomicfu.locks

ReentrantLock is designed for delegation. You write val lock = reentrantLock() to construct its instance and use lock/tryLock/unlock functions or lock.withLock { ... } extension function similarly to the way jucl.ReentrantLock is used on JVM. On JVM it is a typealias to the later class, erased on JS.

Report a problem

actual typealias ReentrantLock = SynchronizedObject

ReentrantLock from kotlinx.atomicfu.locks

ReentrantLock is designed for delegation. You write val lock = reentrantLock() to construct its instance and use lock/tryLock/unlock functions or lock.withLock { ... } extension function similarly to the way jucl.ReentrantLock is used on JVM. On JVM it is a typealias to the later class, erased on JS.

Report a problem

actual class ReentrantLock(source)

ReentrantLock from kotlinx.atomicfu.locks

ReentrantLock is designed for delegation. You write val lock = reentrantLock() to construct its instance and use lock/tryLock/unlock functions or lock.withLock { ... } extension function similarly to the way jucl.ReentrantLock is used on JVM. On JVM it is a typealias to the later class, erased on JS.

Report a problem

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
expect fun lock()

Acquires the lock. If the lock is already held by another thread, the current thread will block until it can acquire the lock.

actual inline fun lock()

Acquires the lock. If the lock is already held by another thread, the current thread will block until it can acquire the lock.

Link copied to clipboard
expect fun tryLock(): Boolean

Attempts to acquire the lock. If the lock is available, it will be acquired, and this function will return true. If the lock is already held by another thread, this function will return false immediately without blocking.

actual inline fun tryLock(): Boolean

Attempts to acquire the lock. If the lock is available, it will be acquired, and this function will return true. If the lock is already held by another thread, this function will return false immediately without blocking.

Link copied to clipboard
expect fun unlock()

Releases the lock. If the current thread holds the lock, it will be released, allowing other threads to acquire it.

actual inline fun unlock()

Releases the lock. If the current thread holds the lock, it will be released, allowing other threads to acquire it.

Link copied to clipboard
expect inline fun <T> ReentrantLock.withLock(block: () -> T): T

Executes the given block of code while holding the specified ReentrantLock. This function simplifies the process of acquiring and releasing a lock safely.

actual inline fun <T> ReentrantLock.withLock(block: () -> T): T

Executes the given block of code while holding the specified ReentrantLock. This function simplifies the process of acquiring and releasing a lock safely.

actual inline fun <T> ReentrantLock.withLock(block: () -> T): T

Executes the given block of code while holding the specified ReentrantLock. This function simplifies the process of acquiring and releasing a lock safely.

actual inline fun <T> ReentrantLock.withLock(block: () -> T): T

Executes the given block of code while holding the specified ReentrantLock. This function simplifies the process of acquiring and releasing a lock safely.

Generated by Dokka
© 2026 JetBrains s.r.o and contributors. Apache License 2.0