ai.eloquent.util

Class SafeTimerTask

java.lang.Object

java.util.TimerTask

ai.eloquent.util.SafeTimerTask

All Implemented Interfaces:

java.lang.Runnable

public abstract class SafeTimerTask
extends java.util.TimerTask

All TimerTask objects crash their parent thread when they throw an exception, so we wrap timers in SafeTimerTask objects, which don't.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	cancelled If true, this task has been cancelled.
static int	MAX_SIMULTANEOUS_RUNS This is the maximum number of simultaneous runs of this task that we'll allow.

Constructor Summary

Constructors

Constructor and Description
SafeTimerTask()

Method Summary

Modifier and Type	Method and Description
boolean	cancel()
protected java.util.concurrent.ExecutorService	pool() An overwritable function for getting the pool that we should run this timer's tasks on.
void	registerCancelCallback(java.lang.Runnable runnable) Sometimes we want to be notified when things cancel.
void	run()
void	run(java.util.concurrent.Executor pool) Run this task on the given pool.
void	run(java.util.Optional<java.util.concurrent.Executor> pool) Run this job on an optional pool.
abstract void	runUnsafe() The implementation of the task, except that we are allowed to throw arbitrary exceptions.

Methods inherited from class java.util.TimerTask

scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Field Detail

cancelled

public boolean cancelled

If true, this task has been cancelled.

MAX_SIMULTANEOUS_RUNS

public static final int MAX_SIMULTANEOUS_RUNS

This is the maximum number of simultaneous runs of this task that we'll allow. Any runs beyond this count will be dropped on the floor, and will issue an error.

See Also:

Constant Field Values

Constructor Detail

SafeTimerTask

public SafeTimerTask()

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

Specified by:

run in class java.util.TimerTask

run

public void run(java.util.Optional<java.util.concurrent.Executor> pool)

Run this job on an optional pool.

Parameters:

pool - The executor pool to run on.

run

public void run(java.util.concurrent.Executor pool)

Run this task on the given pool. An alias for run(Optional).

Parameters:

pool - The pool to run on.

registerCancelCallback

public void registerCancelCallback(java.lang.Runnable runnable)

Sometimes we want to be notified when things cancel.

cancel

public boolean cancel()

Overrides:

cancel in class java.util.TimerTask

pool

protected java.util.concurrent.ExecutorService pool()

An overwritable function for getting the pool that we should run this timer's tasks on.

runUnsafe

public abstract void runUnsafe()
                        throws java.lang.Throwable

The implementation of the task, except that we are allowed to throw arbitrary exceptions.

Throws:

java.lang.Throwable - An exception that this runner is allowed to throw.