io.nadron.service

Interface TaskManagerService

All Known Implementing Classes:

SimpleTaskManagerService

public interface TaskManagerService

Defines and interface for management of tasks in the server. It declares functionality for executing recurring tasks with delay etc. The interface may also be used as a repository of tasks, with features like persistence built in by the implementation.

Author:

Abraham Menacherry

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(Task task)
ScheduledFuture	schedule(Task task, long delay, TimeUnit unit) Creates and executes a one-shot action that becomes enabled after the given delay.
ScheduledFuture	scheduleAtFixedRate(Task task, long initialDelay, long period, TimeUnit unit) Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is executions will commence after initialDelay then initialDelay+period, then initialDelay + 2 * period, and so on.
ScheduledFuture	scheduleWithFixedDelay(Task task, long initialDelay, long delay, TimeUnit unit) Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next.

Method Detail

execute

void execute(Task task)

schedule

ScheduledFuture schedule(Task task,
                       long delay,
                       TimeUnit unit)

Creates and executes a one-shot action that becomes enabled after the given delay.

Parameters:

task - The task to be scheduled.

delay - Initial delay before the task is executed

unit - seconds, milliseconds etc for delay

Returns:

A scheduled future, which is a handle to the task and can be used to cancel it, get completed status etc.

scheduleAtFixedRate

ScheduledFuture scheduleAtFixedRate(Task task,
                                  long initialDelay,
                                  long period,
                                  TimeUnit unit)

Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given period; that is executions will commence after initialDelay then initialDelay+period, then initialDelay + 2 * period, and so on.

Parameters:

task - The task to be scheduled.

initialDelay - Initial delay before the task is first done.

period - Fixed period of execution.

unit - seconds, milliseconds etc for delay.

Returns:

A scheduled future, which is a handle to the task and can be used to cancel it, get completed status etc.

scheduleWithFixedDelay

ScheduledFuture scheduleWithFixedDelay(Task task,
                                     long initialDelay,
                                     long delay,
                                     TimeUnit unit)

Creates and executes a periodic action that becomes enabled first after the given initial delay, and subsequently with the given delay between the termination of one execution and the commencement of the next.

Parameters:

task - The task to be scheduled.

initialDelay - Initial delay before the task is first done.

delay - The delay between each subsequent execution

unit - seconds, milliseconds etc for delay.

Returns:

A scheduled future, which is a handle to the task and can be used to cancel it, get completed status etc.