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

Mutable

class Mutable(permits: Int, acquiredPermits: Int = 0) : SmartSemaphore(source)

Mutable variant of SmartSemaphore. 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 freePermits and its internal _freePermitsStateFlow

Constructors

Mutable

constructor(permits: Int, acquiredPermits: Int = 0)

Properties

freePermits

open val freePermits: Int

The number of the available permits.

maxPermits

open override val maxPermits: Int

permitsStateFlow

open override val permitsStateFlow: StateFlow<Int>

Functions

acquire

suspend fun acquire(permits: Int = 1)

Holds call until this SmartSemaphore will be re-locked. That means that current method will

immutable

fun immutable(): SmartSemaphore.Immutable

release

suspend fun release(permits: Int = 1): Boolean

If freePermits == true - will change it to false and return true. If current call will not unlock this SmartSemaphore - false

tryAcquire

suspend fun tryAcquire(permits: Int = 1): Boolean

Will try to lock this SmartSemaphore immediataly

waitRelease

suspend fun SmartSemaphore.waitRelease(permits: Int = 1): Int

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

waitReleaseAll

suspend fun SmartSemaphore.waitReleaseAll(): Int

withAcquire

inline suspend fun <T> SmartSemaphore.Mutable.withAcquire(permits: Int = 1, action: () -> T): T

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