commonMain.jetbrains.datalore.base.async.Async.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lets-plot-common Show documentation

Lets-Plot JVM package without rendering part

There is a newer version: 4.5.3-alpha1

/*
 * Copyright (c) 2019. JetBrains s.r.o.
 * Use of this source code is governed by the MIT license that can be found in the LICENSE file.
 */

package jetbrains.datalore.base.async

import jetbrains.datalore.base.function.Consumer
import jetbrains.datalore.base.registration.Registration

/**
 * Asynchronous computation
 * You must eventually call either succeedHandler or failureHandler.
 * If you imply a condition on handlers calls (i.e. synchronization)
 * you should imply the same conditions on map/flatMap handlers, and vice versa.
 *
 * Users aren't required to call [Registration.remove] for registrations returned by handle methods.
 * Implementations should make appropriate cleanup to avoid memory leaks when async is succeeded or failed.
 */
interface Async {
    fun onSuccess(successHandler: Consumer): Registration
    fun onResult(successHandler: Consumer, failureHandler: Consumer): Registration
    fun onFailure(failureHandler: Consumer): Registration

    /**
     * This method must always create new async every time it's called.
     * Every error thrown in `success` should fail async with corresponding `Throwable`
     */
    fun  map(success: (ItemT) -> ResultT): Async

    /**
     * Should comply with A+ promise 'then' method except it has no failure handler.
     * See [A+ promise spec](https://promisesaplus.com/) for more detail.
     * This method must always create new async every time it's called.
     * Every error thrown in `success` should fail async with corresponding `Throwable`
    */
    fun  flatMap(success: (ItemT) -> Async?): Async
}