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

SmartSemaphore

It is interface which will work like classic Semaphore, but in difference have permitsStateFlow for listening of the SmartSemaphore state.

There is Mutable and Immutable realizations. In case you are owner and manager current state of lock, you need Mutable. Otherwise, Immutable.

Any Mutable may produce its Immutable variant which will contains permitsStateFlow equal to its Mutable creator

Inheritors

Immutable

Mutable

Types

Immutable

class Immutable(val permitsStateFlow: StateFlow<Int>) : SmartSemaphore

Immutable variant of SmartSemaphore. In fact will depend on the owner of permitsStateFlow

Mutable

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

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

Properties

freePermits

open val freePermits: Int

permitsStateFlow

abstract val permitsStateFlow: StateFlow<Int>

Functions

waitRelease

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

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