micro_utils.dokka/dev.inmo.micro_utils.coroutines/SmartMutex/Mutable

Mutable

class Mutable(locked: Boolean = false) : SmartMutex(source)

Mutable variant of SmartMutex. With that variant you may lock and unlock. Besides, you may create Immutable variant of this instance with immutable factory

Parameters

locked

Preset state of isLocked and its internal _lockStateFlow

Constructors

Mutable

constructor(locked: Boolean = false)

Properties

isLocked

open val isLocked: Boolean

lockStateFlow

open override val lockStateFlow: StateFlow<Boolean>

Functions

immutable

fun immutable(): SmartMutex.Immutable

lock

suspend fun lock()

tryLock

suspend fun tryLock(): Boolean

unlock

suspend fun unlock(): Boolean

waitUnlock

suspend fun SmartMutex.waitUnlock(): Boolean

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

withLock

inline suspend fun <T> SmartMutex.Mutable.withLock(action: () -> T): T

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