de.esoco.coroutine.step

Class ChannelReceive<T>

java.lang.Object

org.obrel.core.RelatedObject

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

de.esoco.coroutine.step.ChannelStep<java.lang.Void,T>

de.esoco.coroutine.step.ChannelReceive<T>

All Implemented Interfaces:

de.esoco.lib.property.Fluent<CoroutineStep<java.lang.Void,T>>, org.obrel.core.FluentRelatable<CoroutineStep<java.lang.Void,T>>, org.obrel.core.Relatable

public class ChannelReceive<T>
extends ChannelStep<java.lang.Void,T>

A coroutine step that receives a value from a channel. If the channel is empty at the time of this step's invocation the coroutine execution will be suspended until channel data becomes available. The channel to receive from will be queried (and if not existing created) with CoroutineScope.getChannel(ChannelId).

Constructor Summary

Constructors

Constructor and Description
ChannelReceive(java.util.function.Function<Continuation<?>,ChannelId<T>> fGetChannelId) Creates a new instance that receives from a channel the ID of which is provided in a state relation.

Method Summary

Modifier and Type	Method and Description
protected T	execute(java.lang.Void rIgnored, Continuation<?> rContinuation) This method must be implemented by subclasses to provide the actual functionality of this step.
static <T> ChannelReceive<T>	receive(ChannelId<T> rId) Suspends until a value can be received from a certain channel.
static <T> ChannelReceive<T>	receive(java.util.function.Function<Continuation<?>,ChannelId<T>> fGetChannelId) Suspends until a value can be received from the channel with the ID provided by the given function.
void	runAsync(java.util.concurrent.CompletableFuture<java.lang.Void> fPreviousExecution, CoroutineStep<T,?> rNextStep, 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.step.ChannelStep

getChannel

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

ChannelReceive

public ChannelReceive(java.util.function.Function<Continuation<?>,ChannelId<T>> fGetChannelId)

Creates a new instance that receives from a channel the ID of which is provided in a state relation.

Parameters:

fGetChannelId - The function that will return the channel ID

Method Detail

receive

public static <T> ChannelReceive<T> receive(ChannelId<T> rId)

Suspends until a value can be received from a certain channel.

Parameters:

rId - The ID of the channel to receive from

Returns:

A new instance of this class

receive

public static <T> ChannelReceive<T> receive(java.util.function.Function<Continuation<?>,ChannelId<T>> fGetChannelId)

Suspends until a value can be received from the channel with the ID provided by the given function.

Parameters:

fGetChannelId - The function that will return the channel ID

Returns:

A new step instance

runAsync

public void runAsync(java.util.concurrent.CompletableFuture<java.lang.Void> fPreviousExecution,
                     CoroutineStep<T,?> rNextStep,
                     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<java.lang.Void,T>

Parameters:

fPreviousExecution - The future of the previous code execution

rNextStep - The next step to execute or NULL for none

rContinuation - The continuation of the execution

execute

protected T execute(java.lang.Void rIgnored,
                    Continuation<?> rContinuation)

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

Specified by:

execute in class CoroutineStep<java.lang.Void,T>

Parameters:

rIgnored - The input value

rContinuation - The continuation of the execution

Returns:

The result of the execution