micro_utils.dokka

0.24.0

micro_utils.dokka/dev.inmo.micro_utils.coroutines/SmartRWLocker

SmartRWLocker

class SmartRWLocker(readPermits: Int = Int.MAX_VALUE, writeIsLocked: Boolean = false)(source)

Composite mutex which works with next rules:

acquireRead require to writeMutex be free. Then it will take one lock from readSemaphore
releaseRead will just free up one permit in readSemaphore
lockWrite will lock writeMutex and then await while all readSemaphore will be freed
unlockWrite will just unlock writeMutex

Constructors

constructor(readPermits: Int = Int.MAX_VALUE, writeIsLocked: Boolean = false)

Properties

val readSemaphore: SmartSemaphore.Immutable

val writeMutex: SmartMutex.Immutable

Functions

suspend fun acquireRead()

Do lock in readSemaphore inside of writeMutex locking

suspend fun lockWrite()

Locking writeMutex and wait while all readSemaphore permits will be freed

suspend fun releaseRead(): Boolean

Release one read permit in readSemaphore

suspend fun unlockWrite(): Boolean

Unlock writeMutex

waitReadRelease

suspend fun SmartRWLocker.waitReadRelease(permits: Int = 1): Int

Will wait until the SmartSemaphore.permitsStateFlow of this instance will have permits count free permits.

waitWriteUnlock

suspend fun SmartRWLocker.waitWriteUnlock(): Boolean

Will wait until the SmartMutex.lockStateFlow of this instance will be false.

withReadAcquire

inline suspend fun <T> SmartRWLocker.withReadAcquire(action: () -> T): T

Will call SmartSemaphore.Mutable.lock, then execute action and return the result after SmartSemaphore.Mutable.unlock

inline suspend fun <T> SmartRWLocker.withWriteLock(action: () -> T): T

Will call SmartMutex.Mutable.lock, then execute action and return the result after SmartMutex.Mutable.unlock