commonMain.com.badoo.reaktive.utils.lock.ConditionLock.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of utils-internal-jvm Show documentation

Kotlin multi-platform implementation of Reactive Extensions

There is a newer version: 2.3.0

package com.badoo.reaktive.utils.lock

import com.badoo.reaktive.utils.InternalReaktiveApi
import kotlin.time.Duration

@Suppress("EmptyDefaultConstructor")
@InternalReaktiveApi
expect open class ConditionLock() {

    fun lock()

    fun unlock()

    /**
     * Causes the current thread to wait until it is signalled or interrupted,
     * or the specified waiting time elapses.
     *
     * @param timeout the maximum time to wait.
     * @return an estimate of the [timeout] value minus the time spent waiting upon return from this method.
     * A positive value may be used as the argument to a subsequent call to this method to finish waiting out
     * the desired time. A value less than or equal to zero indicates that no time remains.
     */
    fun await(timeout: Duration = Duration.INFINITE): Duration

    /** Wakes up all waiting threads. */
    fun signal()
}