com.remondis.limbus.tasks.TaskScheduler Maven / Gradle / Ivy

Go to download
package com.remondis.limbus.tasks;

import java.util.List;
import java.util.function.Function;

import com.remondis.limbus.api.IInitializable;

/**
 * This is the global task scheduler that provides fixed rate scheduling for periodic tasks.
 *
 * @author schuettec
 *
 */
public interface TaskScheduler extends IInitializable {

  /**
   * Removes a scheduled {@link Task} from the periodic task scheduler..
   *
   * @param task
   *        The task to schedule
   */
  public void unschedulePeriodicTask(Task task);

  /**
   * Schedules a {@link Task} for periodic execution using an adaptive frequency.
   *
   * @param task
   *        The task to schedule
   * @param scheduleRateFunction
   *        The function that calculates the task execution frequency in milliseconds based on the last
   *        success status. Note: The minimum frequency is 500ms!
   */
  public void schedulePeriodicTask(Task task, Function scheduleRateFunction);

  /**
   * @return Returns the current snapshot of the tasks scheduled.
   */
  public List getSchedulerInfo();
}