future
fun <T> future(
context: CoroutineContext = DefaultDispatcher,
start: CoroutineStart = CoroutineStart.DEFAULT,
parent: Job? = null,
block: suspend CoroutineScope.() -> T
): CompletableFuture<T>Starts new coroutine and returns its result as an implementation of CompletableFuture. This coroutine builder uses CommonPool context by default and is conceptually similar to CompletableFuture.supplyAsync.
The running coroutine is cancelled when the resulting future is cancelled or otherwise completed.
The context for the new coroutine can be explicitly specified.
See CoroutineDispatcher for the standard context implementations that are provided by kotlinx.coroutines.
The context of the parent coroutine from its scope may be used,
in which case the Job of the resulting coroutine is a child of the job of the parent coroutine.
The parent job may be also explicitly specified using parent parameter.
If the context does not have any dispatcher nor any other ContinuationInterceptor, then DefaultDispatcher is used.
By default, the coroutine is immediately scheduled for execution.
Other options can be specified via start parameter. See CoroutineStart for details.
A value of CoroutineStart.LAZY is not supported
(since CompletableFuture framework does not provide the corresponding capability) and
produces IllegalArgumentException.
See newCoroutineContext for a description of debugging facilities that are available for newly created coroutine.
Parameters
context - context of the coroutine. The default value is DefaultDispatcher.
start - coroutine start option. The default value is CoroutineStart.DEFAULT.
parent - explicitly specifies the parent job, overrides job from the context (if any).
block - the coroutine code.