io.ebean.BackgroundExecutor Maven / Gradle / Ivy

Go to download

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

composite of common runtime dependencies for all platforms

There is a newer version: 15.8.1

package io.ebean;

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

/**
 * Background thread pool service for executing of tasks asynchronously.
 * 
 * This service is used internally by Ebean for executing background tasks such
 * as the {@link Query#findFutureList()} and also for executing background tasks
 * periodically.
 * 
 * 
 * This service has been made available so you can use it for your application
 * code if you want. It can be useful for some server caching implementations
 * (background population and trimming of the cache etc).
 * 
 *
 * @author rbygrave
 */
public interface BackgroundExecutor {

  /**
   * Execute a task in the background.
   */
  void execute(Runnable r);

  /**
   * Execute a task periodically with a fixed delay between each execution.
   * 
   * For example, execute a runnable every minute.
   * 
   * 
   * The delay is the time between executions no matter how long the task took.
   * That is, this method has the same behaviour characteristics as
   * {@link ScheduledExecutorService#scheduleWithFixedDelay(Runnable, long, long, TimeUnit)}
   * 
   */
  void executePeriodically(Runnable r, long delay, TimeUnit unit);
}