jadex.bridge.component

Interface IExecutionFeature

public interface IExecutionFeature

The execution feature allows to schedule steps to be synchronously executed on the component.

Field Summary

Fields

Modifier and Type	Field and Description
static int	STEP_PRIORITY_IMMEDIATE Constant for first immediate step level.
static int	STEP_PRIORITY_NOMRAL Constant for first normal step level.

Method Summary

Modifier and Type	Method and Description
<T> IIntermediateResultListener<T>	createResultListener(IIntermediateResultListener<T> listener) Create a result listener that is executed on the component thread.
<T> IResultListener<T>	createResultListener(IResultListener<T> listener) Create a result listener that is executed on the component thread.
boolean	isComponentThread() Test if current thread is the component thread.
<T> ISubscriptionIntermediateFuture<T>	repeatStep(long initialDelay, long delay, IComponentStep<T> step) Repeats a ComponentStep periodically, until terminate() is called on result future or a failure occurs in a step.
<T> ISubscriptionIntermediateFuture<T>	repeatStep(long initialDelay, long delay, IComponentStep<T> step, boolean ignorefailures) Repeats a ComponentStep periodically, until terminate() is called on result future.
<T> IFuture<T>	scheduleStep(IComponentStep<T> step) Execute a component step.
<T> IFuture<T>	scheduleStep(int priority, IComponentStep<T> step) Execute a component step.
IFuture<java.lang.Void>	waitForDelay(long delay) Wait for some time.
IFuture<java.lang.Void>	waitForDelay(long delay, boolean realtime) Wait for some time.
<T> IFuture<T>	waitForDelay(long delay, IComponentStep<T> step) Wait for some time and execute a component step afterwards.
<T> IFuture<T>	waitForDelay(long delay, IComponentStep<T> step, boolean realtime) Wait for some time and execute a component step afterwards.
IFuture<java.lang.Void>	waitForTick() Wait for the next tick.
IFuture<java.lang.Void>	waitForTick(IComponentStep<java.lang.Void> run) Wait for the next tick.

Field Detail

STEP_PRIORITY_NOMRAL

static final int STEP_PRIORITY_NOMRAL

Constant for first normal step level.

See Also:

Constant Field Values

STEP_PRIORITY_IMMEDIATE

static final int STEP_PRIORITY_IMMEDIATE

Constant for first immediate step level.

See Also:

Constant Field Values

Method Detail

scheduleStep

<T> IFuture<T> scheduleStep(IComponentStep<T> step)

Execute a component step.

Parameters:

step - The component step.

scheduleStep

<T> IFuture<T> scheduleStep(int priority,
                            IComponentStep<T> step)

Execute a component step.

Parameters:

step - The component step.

priority - The step priority. The priority x>STEP_PRIORITY_IMMEDIATE being immediate steps, i.e. all steps with prio x>=STEP_PRIORITY_IMMEDIATE are always executed (even when suspended). Default steps get prio STEP_PRIORITY_NOMRAL (not immediate).

waitForDelay

<T> IFuture<T> waitForDelay(long delay,
                            IComponentStep<T> step,
                            boolean realtime)

Wait for some time and execute a component step afterwards.

waitForDelay

<T> IFuture<T> waitForDelay(long delay,
                            IComponentStep<T> step)

Wait for some time and execute a component step afterwards.

waitForDelay

IFuture<java.lang.Void> waitForDelay(long delay,
                                     boolean realtime)

Wait for some time.

waitForDelay

IFuture<java.lang.Void> waitForDelay(long delay)

Wait for some time.

waitForTick

IFuture<java.lang.Void> waitForTick(IComponentStep<java.lang.Void> run)

Wait for the next tick.

Parameters:

time - The time.

waitForTick

IFuture<java.lang.Void> waitForTick()

Wait for the next tick.

Parameters:

time - The time.

isComponentThread

boolean isComponentThread()

Test if current thread is the component thread.

Returns:

True if the current thread is the component thread.

createResultListener

<T> IResultListener<T> createResultListener(IResultListener<T> listener)

Create a result listener that is executed on the component thread.

createResultListener

<T> IIntermediateResultListener<T> createResultListener(IIntermediateResultListener<T> listener)

Create a result listener that is executed on the component thread.

repeatStep

<T> ISubscriptionIntermediateFuture<T> repeatStep(long initialDelay,
                                                  long delay,
                                                  IComponentStep<T> step)

Repeats a ComponentStep periodically, until terminate() is called on result future or a failure occurs in a step. Warning: In order to avoid memory leaks, the returned subscription future does NOT store values, requiring the addition of a listener within the same step the repeat step was schedule.

Parameters:

initialDelay - delay before first execution in milliseconds

delay - delay between scheduled executions of the step in milliseconds

step - The component step

Returns:

The intermediate results

repeatStep

<T> ISubscriptionIntermediateFuture<T> repeatStep(long initialDelay,
                                                  long delay,
                                                  IComponentStep<T> step,
                                                  boolean ignorefailures)

Repeats a ComponentStep periodically, until terminate() is called on result future. Warning: In order to avoid memory leaks, the returned subscription future does NOT store values, requiring the addition of a listener within the same step the repeat step was schedule.

Parameters:

initialDelay - delay before first execution in milliseconds

delay - delay between scheduled executions of the step in milliseconds

step - The component step

ignorefailures - Don't terminate repeating after a failed step.

Returns:

The intermediate results