com.screenscraper.concurrent

Class TimedExecutorService

java.lang.Object

java.util.concurrent.AbstractExecutorService

java.util.concurrent.ThreadPoolExecutor

com.screenscraper.concurrent.TimedExecutorService

All Implemented Interfaces:

java.util.concurrent.Executor, java.util.concurrent.ExecutorService

public class TimedExecutorService
extends java.util.concurrent.ThreadPoolExecutor

Executor Service that allows for an execution time to be set on a task. If it hasn't completed by the end of the time, it will be interrupted. It is up to the programmer to ensure tasks check to see if they have been cancelled.
This version (as of 2.0) no longer wraps an executor service, but rather implements one. It now also supports running tasks in the same thread, and they will be cancelled mid run like any other task
Update to version 2.1: This version now includes additional attempts to keep the memory footprint smaller by clearing the cancellation task queue

Version:

2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimedExecutorService.Builder Builder class for setting up the timed executor service

Nested classes/interfaces inherited from class java.util.concurrent.ThreadPoolExecutor

java.util.concurrent.ThreadPoolExecutor.AbortPolicy, java.util.concurrent.ThreadPoolExecutor.CallerRunsPolicy, java.util.concurrent.ThreadPoolExecutor.DiscardOldestPolicy, java.util.concurrent.ThreadPoolExecutor.DiscardPolicy

Method Summary

Modifier and Type	Method and Description
long	getDefaultRunDuration() Gets the default run duration, in milliseconds, that will be set for tasks with no duration specified.
protected <T> java.util.concurrent.RunnableFuture<T>	newTaskFor(java.util.concurrent.Callable<T> callable)
protected <T> java.util.concurrent.RunnableFuture<T>	newTaskFor(java.lang.Runnable runnable, T result)
void	setDefaultRunDuration(long duration) Sets the default run duration, in milliseconds, that will be set for tasks with no duration specified.
void	shutdown()
java.util.List<java.lang.Runnable>	shutdownNow()
<T> java.util.concurrent.Future<T>	submitTaskWithDuration(java.util.concurrent.Callable<T> task, long duration) Runs a task, cancelling it after the specified duration has passed from the time it started running.
java.util.concurrent.Future<java.lang.Boolean>	submitTaskWithDuration(java.lang.Runnable task, long duration) Runs a task, cancelling it after the specified duration has passed from the time it started running.
<T> java.util.concurrent.Future<T>	submitTaskWithDuration(java.lang.Runnable task, T result, long duration) Runs a task, cancelling it after the specified duration has passed from the time it started running.
<T> java.util.concurrent.Future<T>	submitTaskWithDurationAndEndTime(java.util.concurrent.Callable<T> task, long duration, long endTime) Runs a task, cancelling it after the specified duration has passed from the time it started running, or if it hasn't finished by the given time.
java.util.concurrent.Future<java.lang.Boolean>	submitTaskWithDurationAndEndTime(java.lang.Runnable task, long duration, long endTime) Runs a task, cancelling it after the specified duration has passed from the time it started running, or if it hasn't finished by the given time.
<T> java.util.concurrent.Future<T>	submitTaskWithDurationAndEndTime(java.lang.Runnable task, T result, long duration, long endTime) Runs a task, cancelling it after the specified duration has passed from the time it started running, or if it hasn't finished by the given time.
<T> java.util.concurrent.Future<T>	submitTaskWithEndTime(java.util.concurrent.Callable<T> task, long endTime) Runs a task, cancelling it if it hasn't finished by the given time
java.util.concurrent.Future<java.lang.Boolean>	submitTaskWithEndTime(java.lang.Runnable task, long endTime) Runs a task, cancelling it if it hasn't finished by the given time
<T> java.util.concurrent.Future<T>	submitTaskWithEndTime(java.lang.Runnable task, T result, long endTime) Runs a task, cancelling it if it hasn't finished by the given time
<T> java.util.concurrent.Future<T>	submitUntimedTask(java.util.concurrent.Callable<T> callable) Submits the given task but doesn't time it's execution.
java.util.concurrent.Future<?>	submitUntimedTask(java.lang.Runnable runnable) Submits the given task but doesn't time it's execution.
java.lang.String	toString()

Methods inherited from class java.util.concurrent.ThreadPoolExecutor

afterExecute, allowCoreThreadTimeOut, allowsCoreThreadTimeOut, awaitTermination, beforeExecute, execute, finalize, getActiveCount, getCompletedTaskCount, getCorePoolSize, getKeepAliveTime, getLargestPoolSize, getMaximumPoolSize, getPoolSize, getQueue, getRejectedExecutionHandler, getTaskCount, getThreadFactory, isShutdown, isTerminated, isTerminating, prestartAllCoreThreads, prestartCoreThread, purge, remove, setCorePoolSize, setKeepAliveTime, setMaximumPoolSize, setRejectedExecutionHandler, setThreadFactory, terminated

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny, submit, submit, submit

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getDefaultRunDuration

public long getDefaultRunDuration()

Gets the default run duration, in milliseconds, that will be set for tasks with no duration specified. Negative values indicate infinite time

Returns:

The default duration, in milliseconds, to set for tasks with no duration specified. Negative values indicate infinite time

setDefaultRunDuration

public void setDefaultRunDuration(long duration)

Sets the default run duration, in milliseconds, that will be set for tasks with no duration specified. Negative values indicate infinite time

Parameters:

duration - The default run duration, in milliseconds, that will be set for tasks with no duration specified. Negative values indicate infinite time

shutdown

public void shutdown()

Specified by:

shutdown in interface java.util.concurrent.ExecutorService

Overrides:

shutdown in class java.util.concurrent.ThreadPoolExecutor

shutdownNow

@NotNull
public java.util.List<java.lang.Runnable> shutdownNow()

Specified by:

shutdownNow in interface java.util.concurrent.ExecutorService

Overrides:

shutdownNow in class java.util.concurrent.ThreadPoolExecutor

newTaskFor

@NotNull
protected <T> java.util.concurrent.RunnableFuture<T> newTaskFor(java.lang.Runnable runnable,
                                                                          T result)

Overrides:

newTaskFor in class java.util.concurrent.AbstractExecutorService

newTaskFor

@NotNull
protected <T> java.util.concurrent.RunnableFuture<T> newTaskFor(java.util.concurrent.Callable<T> callable)

Overrides:

newTaskFor in class java.util.concurrent.AbstractExecutorService

submitUntimedTask

@NotNull
public <T> java.util.concurrent.Future<T> submitUntimedTask(@NotNull
                                                                      java.util.concurrent.Callable<T> callable)

Submits the given task but doesn't time it's execution. Allows it to run forever

Type Parameters:

T - The type of the returned data

Parameters:

callable - The task to run

Returns:

The Future used for getting the data and status updates

submitUntimedTask

@NotNull
public java.util.concurrent.Future<?> submitUntimedTask(@NotNull
                                                                  java.lang.Runnable runnable)

Submits the given task but doesn't time it's execution. Allows it to run forever

Parameters:

runnable - The task to run

Returns:

The Future used for status updates

submitTaskWithDuration

@NotNull
public <T> java.util.concurrent.Future<T> submitTaskWithDuration(@NotNull
                                                                           java.util.concurrent.Callable<T> task,
                                                                           long duration)

Runs a task, cancelling it after the specified duration has passed from the time it started running.

Type Parameters:

T - The type of data to return

Parameters:

task - The task to run

duration - The maximum duration for which the task should run, in milliseconds (from the time it actually starts)

Returns:

The Future that can be used to get the result upon completion

submitTaskWithDuration

@NotNull
public java.util.concurrent.Future<java.lang.Boolean> submitTaskWithDuration(@NotNull
                                                                                       java.lang.Runnable task,
                                                                                       long duration)

Runs a task, cancelling it after the specified duration has passed from the time it started running.

Parameters:

task - The task to run

duration - The maximum duration for which the task should run, in milliseconds (from the time it actually starts)

Returns:

The Future that can be used to get the result upon completion

submitTaskWithDuration

@NotNull
public <T> java.util.concurrent.Future<T> submitTaskWithDuration(@NotNull
                                                                           java.lang.Runnable task,
                                                                           T result,
                                                                           long duration)

Runs a task, cancelling it after the specified duration has passed from the time it started running.

Type Parameters:

T - The type of data to return

Parameters:

task - The task to run

result - The value to return when the task finishes

duration - The maximum duration for which the task should run, in milliseconds (from the time it actually starts)

Returns:

The Future that can be used to get the result upon completion

submitTaskWithEndTime

@NotNull
public <T> java.util.concurrent.Future<T> submitTaskWithEndTime(@NotNull
                                                                          java.util.concurrent.Callable<T> task,
                                                                          long endTime)

Runs a task, cancelling it if it hasn't finished by the given time

Type Parameters:

T - The type of data to return

Parameters:

task - The task to run

endTime - The time at which the task should end if it hasn't finished yet

Returns:

The Future that can be used to get the result upon completion

submitTaskWithEndTime

@NotNull
public java.util.concurrent.Future<java.lang.Boolean> submitTaskWithEndTime(@NotNull
                                                                                      java.lang.Runnable task,
                                                                                      long endTime)

Runs a task, cancelling it if it hasn't finished by the given time

Parameters:

task - The task to run

endTime - The time at which the task should end if it hasn't finished yet

Returns:

The Future that can be used to get the result upon completion

submitTaskWithEndTime

@NotNull
public <T> java.util.concurrent.Future<T> submitTaskWithEndTime(@NotNull
                                                                          java.lang.Runnable task,
                                                                          T result,
                                                                          long endTime)

Runs a task, cancelling it if it hasn't finished by the given time

Type Parameters:

T - The type of data to return

Parameters:

task - The task to run

result - The value to return when the task finishes

endTime - The time at which the task should end if it hasn't finished yet

Returns:

The Future that can be used to get the result upon completion

submitTaskWithDurationAndEndTime

@NotNull
public <T> java.util.concurrent.Future<T> submitTaskWithDurationAndEndTime(@NotNull
                                                                                     java.util.concurrent.Callable<T> task,
                                                                                     long duration,
                                                                                     long endTime)

Runs a task, cancelling it after the specified duration has passed from the time it started running, or if it hasn't finished by the given time.

Type Parameters:

T - The type of data to return

Parameters:

task - The task to run

duration - The maximum duration for which the task should run, in milliseconds (from the time it actually starts)

endTime - The time at which the task should end if it hasn't finished yet

Returns:

The Future that can be used to get the result upon completion

submitTaskWithDurationAndEndTime

@NotNull
public java.util.concurrent.Future<java.lang.Boolean> submitTaskWithDurationAndEndTime(@NotNull
                                                                                                 java.lang.Runnable task,
                                                                                                 long duration,
                                                                                                 long endTime)

Runs a task, cancelling it after the specified duration has passed from the time it started running, or if it hasn't finished by the given time.

Parameters:

task - The task to run

duration - The maximum duration for which the task should run, in milliseconds (from the time it actually starts)

endTime - The time at which the task should end if it hasn't finished yet

Returns:

The Future that can be used to get the result upon completion

submitTaskWithDurationAndEndTime

@NotNull
public <T> java.util.concurrent.Future<T> submitTaskWithDurationAndEndTime(@NotNull
                                                                                     java.lang.Runnable task,
                                                                                     T result,
                                                                                     long duration,
                                                                                     long endTime)

Runs a task, cancelling it after the specified duration has passed from the time it started running, or if it hasn't finished by the given time.

Type Parameters:

T - The type of data to return

Parameters:

task - The task to run

result - The value to return when the task finishes

duration - The maximum duration for which the task should run, in milliseconds (from the time it actually starts)

endTime - The time at which the task should end if it hasn't finished yet

Returns:

The Future that can be used to get the result upon completion

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.util.concurrent.ThreadPoolExecutor