jadex.bridge.component.IExecutionFeature Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jadex-platform-bridge Show documentation
Jadex bridge is a base package for kernels and platforms, i.e., it is used by both and provides commonly used interfaces and classes for active components and their management.
There is a newer version: 4.0.267
Show newest version
package jadex.bridge.component;

import jadex.bridge.service.types.cms.IComponentDescription;
import jadex.commons.future.IIntermediateResultListener;
import jadex.commons.future.IResultListener;

/**
 *  The execution feature allows to schedule steps
 *  to be synchronously executed on the component.
 */
public interface IExecutionFeature extends IExternalExecutionFeature
{
	/** Constant for first normal step level. */
	public static final int STEP_PRIORITY_NORMAL = 0;

	/** Constant for first immediate step level. */
	public static final int STEP_PRIORITY_IMMEDIATE = 100;
	
//	/**
//	 *  Execute a component step.
//	 *  @param step The component step.
//	 */
//	public 	IFuture scheduleStep(IComponentStep step);
//	
//	/**
//	 *  Execute a component step.
//	 *  @param step The component step.
//	 *  @param 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). 
//	 */
//	public 	IFuture scheduleStep(int priority, IComponentStep step);
	
//	/**
//	 *  Execute an immediate component step,
//	 *  i.e., the step is executed also when the component is currently suspended.
//	 */
//	public 	IFuture scheduleImmediate(IComponentStep step);
	
//	/**
//	 *  Wait for some time and execute a component step afterwards.
//	 */
//	public 	IFuture waitForDelay(long delay, IComponentStep step, boolean realtime);
//
//	/**
//	 *  Wait for some time and execute a component step afterwards.
//	 */
//	public 	IFuture waitForDelay(long delay, IComponentStep step);
//
//	/**
//	 *  Wait for some time.
//	 */
//	public IFuture waitForDelay(long delay, boolean realtime);
//	
//	/**
//	 *  Wait for some time.
//	 */
//	public IFuture waitForDelay(long delay);
//	
//	/**
//	 *  Wait for the next tick.
//	 *  @param time The time.
//	 */
//	// TimerWrapper
//	public IFuture waitForTick(final IComponentStep run);
	
//	/**
//	 *  Wait for the next tick.
//	 *  @param time The time.
//	 */
//	// TimerWrapper
//	public IFuture waitForTick();
	
	// todo:?
//	/**
//	 *  Wait for some time and execute a component step afterwards.
//	 */
//	public IFuture waitForImmediate(long delay, IComponentStep step);

	/**
	 *  Get the component description.
	 *  @return	The component description.
	 */
	// Todo: hack??? should be internal to CMS!?
	public IComponentDescription getDescription();
		
	/**
	 *  Test if current thread is the component thread.
	 *  @return True if the current thread is the component thread.
	 */
	public boolean isComponentThread();

	/**
	 *  Create a result listener that is executed on the
	 *  component thread.
	 */
	public  IResultListener createResultListener(IResultListener listener);
	
	/**
	 *  Create a result listener that is executed on the
	 *  component thread.
	 */
	public  IIntermediateResultListener createResultListener(IIntermediateResultListener listener);

//	/**
//	 * 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.
//	 * 
//	 * @param initialDelay delay before first execution in milliseconds
//	 * @param delay delay between scheduled executions of the step in milliseconds
//	 * @param step The component step
//	 * @return The intermediate results
//	 */
//	public  ISubscriptionIntermediateFuture repeatStep(long initialDelay, long delay, IComponentStep step);
//	
//	/**
//	 * 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.
//	 * 
//	 * @param initialDelay delay before first execution in milliseconds
//	 * @param delay delay between scheduled executions of the step in milliseconds
//	 * @param step The component step
//	 * @param ignorefailures Don't terminate repeating after a failed step.
//	 * @return The intermediate results
//	 */
//	public  ISubscriptionIntermediateFuture repeatStep(long initialDelay, long delay, IComponentStep step, boolean ignorefailures);
	
}