com.almende.eve.scheduler.Scheduler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eve-core Show documentation

There is a newer version: 3.1.1

package com.almende.eve.scheduler;

import java.util.Set;

import com.almende.eve.rpc.jsonrpc.JSONRequest;

public interface Scheduler {
	/**
	 * Schedule a task
	 * @param request   A JSONRequest with method and params
	 * @param delay     The delay in milliseconds
	 * @return taskId
	 */
	public String createTask(JSONRequest request, long delay);
	
	/**
	 * Schedule a task, potentially running at an interval
	 * 
	 * @param request    A JSONRequest with method and params
	 * @param delay      The delay in milliseconds
	 * @param interval   Should the task be repeated at an interval?
	 * @param sequential Should (long running) tasks run sequential, or may they run in parallel?
	 * @return taskId
	 */
	public String createTask(JSONRequest request, long delay, boolean interval, boolean sequential);

	/**
	 * Cancel a scheduled task by its id
	 * @param taskId
	 */
	public void cancelTask(String id);
	

	/**
	 * Retrieve a list with all scheduled tasks
	 * @return taskIds
	 */
	public Set getTasks();
	
}