org.jetlang.core.Scheduler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jetlang Show documentation

Jetlang provides a high performance java threading library. It is a complement to the java.util.concurrent package introduced in 1.5 and should be used for message based concurrency similar to event based actors in Scala.

There is a newer version: 0.2.23

Show newest version

package org.jetlang.core;

import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;

/**
 * Component that can schedule events to execute in the future. Similar to the {@link ScheduledExecutorService}
 */
public interface Scheduler extends Disposable {

    /**
     * Creates and executes a one-shot action that becomes enabled  after the given delay.
     *
     * @param command the task to execute
     * @param delay   the time from now to delay execution
     * @param unit    the time unit of the delay parameter
     * @return a Disposable that can be used to cancel execution
     */
    Disposable schedule(Runnable command, 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.
     *
     * @param command      the task to execute
     * @param initialDelay the time to delay first execution
     * @param delay        the delay between the termination of one
     *                     execution and the commencement of the next
     * @param unit         the time unit of the initialDelay and delay parameters
     * @return a Disposable that can be used to cancel execution
     */
    Disposable scheduleWithFixedDelay(Runnable command, 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 period; that is executions will commence after initialDelay
     * then initialDelay+period, then initialDelay + 2 * period, and so on.
     * The task will only terminate via cancellation or termination of the executor.
     *
     * @param command      the task to execute
     * @param initialDelay the time to delay first execution
     * @param period       the delay
     * @param unit         the time unit of the initialDelay and delay parameters
     * @return a Disposable that can be used to cancel execution
     */
    Disposable scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit);

}