Package fr.ens.biologie.genomique.eoulsan.core.schedulers

Interface TaskScheduler

All Known Subinterfaces:

ClusterTaskScheduler

All Known Implementing Classes:

AbstractClusterTaskScheduler, AbstractTaskScheduler, BpipeTaskScheduler, BundledScriptBpipeTaskScheduler, ClusterCombinedTaskScheduler, CombinedTaskScheduler, DummyTaskScheduler, HadoopCompatibleTaskScheduler, HTCondorTaskScheduler, MonoThreadTaskScheduler, MultiThreadTaskScheduler, PBSProTaskScheduler, SLURMTaskScheduler, TGCCTaskScheduler, TORQUETaskScheduler

public interface TaskScheduler

This interface define a task scheduler.

Since:

2.0

Author:

Laurent Jourdren

Method Summary

Modifier and Type	Method	Description
StepResult	getResult(Step step)	Get the result related to a step.
StepStatus	getStatus(Step step)	Get the status related to a step.
int	getTaskDoneCount(Step step)	Get the count of done task contexts of a step.
int	getTaskRunningCount(Step step)	Get the count of running task contexts of a step.
int	getTaskSubmittedCount(Step step)	Get the count of submitted task contexts of a step.
int	getTotalTaskDoneCount()	Get the count of done task contexts for the workflow.
int	getTotalTaskRunningCount()	Get the count of running task contexts for the workflow.
int	getTotalTaskSubmittedCount()	Get the count of submitted task contexts for the workflow.
void	start()	Start the scheduler.
void	stop()	Stop the scheduler.
void	submit(Step step, TaskContextImpl context)	Submit a context to execute.
void	submit(Step step, Set<TaskContextImpl> contexts)	Submit contexts to execute.
void	waitEndOfTasks(Step step)	Wait the end of the task contexts.

Method Detail

submit

void submit(Step step,
            Set<TaskContextImpl> contexts)

Submit contexts to execute.

Parameters:

step - step related to the contexts

contexts - contexts to execute

submit

void submit(Step step,
            TaskContextImpl context)

Submit a context to execute.

Parameters:

step - step related to the context

context - context to execute

getStatus

StepStatus getStatus(Step step)

Get the status related to a step.

Parameters:

step - a workflow step

Returns:

the step status object related to the step

getResult

StepResult getResult(Step step)

Get the result related to a step.

Parameters:

step - a workflow step

Returns:

the step result object related to the step

getTaskSubmittedCount

int getTaskSubmittedCount(Step step)

Get the count of submitted task contexts of a step.

Parameters:

step - a workflow step

Returns:

the count of submitted task contexts

getTaskRunningCount

int getTaskRunningCount(Step step)

Get the count of running task contexts of a step.

Parameters:

step - a workflow step

Returns:

the count of running task contexts

getTaskDoneCount

int getTaskDoneCount(Step step)

Get the count of done task contexts of a step.

Parameters:

step - a workflow step

Returns:

the count of done task contexts

waitEndOfTasks

void waitEndOfTasks(Step step)

Wait the end of the task contexts.

Parameters:

step - a workflow step

getTotalTaskSubmittedCount

int getTotalTaskSubmittedCount()

Get the count of submitted task contexts for the workflow.

Returns:

the count of submitted task contexts

getTotalTaskRunningCount

int getTotalTaskRunningCount()

Get the count of running task contexts for the workflow.

Returns:

the count of running task contexts

getTotalTaskDoneCount

int getTotalTaskDoneCount()

Get the count of done task contexts for the workflow.

Returns:

the count of done task contexts

start

void start()

Start the scheduler.

stop

void stop()

Stop the scheduler.