org.gridgain.grid.scheduler

Interface GridScheduler

All Known Implementing Classes:

GridSchedulerImpl

public interface GridScheduler

Provides functionality for scheduling jobs locally using UNIX cron-based syntax. Instance of GridScheduler is obtained from grid as follows:

 GridScheduler s = GridGain.grid().scheduler();
 

Scheduler supports standard UNIX cron format with optional prefix of {n1, n2}, where n1 is delay of scheduling in seconds and n2 is the number of execution. Both parameters are optional. Here's an example of scheduling a closure that broadcasts a message to all nodes five times, once every minute, with initial delay of two seconds:

 GridGain.grid().scheduler().scheduleLocal(
     GridSchedulerFuture<?> = GridGain.grid().scheduler().scheduleLocal(new Callable<Object>() {
         @Override public Object call() throws GridException {
             g.broadcast(new GridCallable() {...}).get();
         }
     }, "{2, 5} * * * * *" // 2 seconds delay with 5 executions only.
 );
 

Method Summary

Methods

Modifier and Type	Method and Description
<R> GridFuture<R>	callLocal(Callable<R> c) Executes given callable on internal system thread pool asynchronously.
GridFuture<?>	runLocal(Runnable r) Executes given closure on internal system thread pool asynchronously.
<R> GridSchedulerFuture<R>	scheduleLocal(Callable<R> c, String ptrn) Schedules job for execution using local cron-based scheduling.
GridSchedulerFuture<?>	scheduleLocal(Runnable job, String ptrn) Schedules job for execution using local cron-based scheduling.

Method Detail

runLocal

GridFuture<?> runLocal(@Nullable
                     Runnable r)

Executes given closure on internal system thread pool asynchronously.

Note that class GridRunnable implements Runnable and class GridOutClosure implements Callable interface.

Parameters:

r - Runnable to execute. If null - this method is no-op.

Returns:

Future for this execution.

See Also:

callLocal(Callable), GridClosure

callLocal

<R> GridFuture<R> callLocal(@Nullable
                          Callable<R> c)

Executes given callable on internal system thread pool asynchronously.

Note that class GridRunnable implements Runnable and class GridOutClosure implements Callable interface.

Type Parameters:

R - Type of the return value for the closure.

Parameters:

c - Callable to execute. If null - this method is no-op.

Returns:

Future for this execution.

See Also:

runLocal(Runnable), GridOutClosure

scheduleLocal

GridSchedulerFuture<?> scheduleLocal(Runnable job,
                                   String ptrn)

Schedules job for execution using local cron-based scheduling.

Parameters:

job - Job to schedule to run as a background cron-based job. If null - this method is no-op.

ptrn - Scheduling pattern in UNIX cron format with optional prefix {n1, n2} where n1 is delay of scheduling in seconds and n2 is the number of execution. Both parameters are optional.

Returns:

Scheduled execution future.

scheduleLocal

<R> GridSchedulerFuture<R> scheduleLocal(Callable<R> c,
                                       String ptrn)

Schedules job for execution using local cron-based scheduling.

Parameters:

c - Job to schedule to run as a background cron-based job.

ptrn - Scheduling pattern in UNIX cron format with optional prefix {n1, n2} where n1 is delay of scheduling in seconds and n2 is the number of execution. Both parameters are optional.

Returns:

Scheduled execution future.