de.esoco.coroutine.step

Class CallSubroutine<I,O>

java.lang.Object

org.obrel.core.RelatedObject

de.esoco.coroutine.CoroutineStep<I,O>

de.esoco.coroutine.step.CallSubroutine<I,O>

All Implemented Interfaces:

de.esoco.lib.property.Fluent<CoroutineStep<I,O>>, org.obrel.core.FluentRelatable<CoroutineStep<I,O>>, org.obrel.core.Relatable

public class CallSubroutine<I,O>
extends CoroutineStep<I,O>

A Coroutine step that executes another coroutine in the context of the parent routine.

Constructor Summary

Constructors

Constructor and Description
CallSubroutine(Coroutine<I,O> rCoroutine) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
static <I,O> CallSubroutine<I,O>	call(Coroutine<I,O> rCoroutine) Calls a coroutine as a subroutine of the coroutine this step is added to.
protected O	execute(I rInput, Continuation<?> rContinuation) This method must be implemented by subclasses to provide the actual functionality of this step.
void	runAsync(java.util.concurrent.CompletableFuture<I> fPreviousExecution, CoroutineStep<O,?> rReturnStep, Continuation<?> rContinuation) Runs this execution step asynchronously as a continuation of a previous code execution in a CompletableFuture and proceeds to the next step afterwards.

Methods inherited from class de.esoco.coroutine.CoroutineStep

fail, runBlocking, terminateCoroutine, toString

Methods inherited from class org.obrel.core.RelatedObject

deleteRelation, get, getRelation, getRelations, notifyRelationListeners, readRelations, relationsEqual, relationsHashCode, relationsString, set, set, transform, writeRelations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.obrel.core.FluentRelatable

with, with, with

Methods inherited from interface org.obrel.core.Relatable

deleteRelation, deleteRelation, deleteRelations, get, get, get, getAll, getRelation, getRelationCount, getRelations, getRelations, hasFlag, hasRelation, hasRelations, init, set, set, set, set, set, streamRelations, transform

Methods inherited from interface de.esoco.lib.property.Fluent

_with

Constructor Detail

CallSubroutine

public CallSubroutine(Coroutine<I,O> rCoroutine)

Creates a new instance.

Parameters:

rCoroutine - The sub-coroutine

Method Detail

call

public static <I,O> CallSubroutine<I,O> call(Coroutine<I,O> rCoroutine)

Calls a coroutine as a subroutine of the coroutine this step is added to.

Parameters:

rCoroutine - The coroutine to invoke as a subroutine

Returns:

The new coroutine step

runAsync

public void runAsync(java.util.concurrent.CompletableFuture<I> fPreviousExecution,
                     CoroutineStep<O,?> rReturnStep,
                     Continuation<?> rContinuation)

Runs this execution step asynchronously as a continuation of a previous code execution in a CompletableFuture and proceeds to the next step afterwards.

Subclasses that need to suspend the invocation of the next step until some condition is met (e.g. sending or receiving data has finished) need to override this method and create a Suspension by invoking Continuation.suspend(CoroutineStep, CoroutineStep) on the next step. If the condition that caused the suspension resolves the coroutine execution can be resumed by calling Suspension.resume(Object).

Subclasses that override this method also need to handle errors by terminating any further execution (i.e. not resuming a suspension if such exists) and forwarding the causing exception to Continuation.fail(Throwable).

Overrides:

runAsync in class CoroutineStep<I,O>

Parameters:

fPreviousExecution - The future of the previous code execution

rReturnStep - The next step to execute or NULL for none

rContinuation - The continuation of the execution

execute

protected O execute(I rInput,
                    Continuation<?> rContinuation)

This method must be implemented by subclasses to provide the actual functionality of this step.

Specified by:

execute in class CoroutineStep<I,O>

Parameters:

rInput - The input value

rContinuation - The continuation of the execution

Returns:

The result of the execution