io.stallion.asyncTasks

Class AsyncFileCoordinator

java.lang.Object

java.lang.Thread

io.stallion.asyncTasks.AsyncCoordinator

io.stallion.asyncTasks.AsyncFileCoordinator

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

AsyncDbCoordinator

public class AsyncFileCoordinator
extends AsyncCoordinator

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
AsyncFileCoordinator()

Method Summary

Modifier and Type	Method and Description
void	enqueue(AsyncTask task) Enqueue a task object, normally you enqueue using task handler, which will then call this method.
AsyncTask	enqueue(AsyncTaskHandler handler) Enqueue a new task runner; a task object will automatically be created for this handler.
AsyncTask	enqueue(AsyncTaskHandler handler, String customKey, long executeAt) Enque a new task handler.
AsyncTask	findAndLockNextTask(Long now) Find the next task that is unlocked and ready for execution, lock it, and return it.
int	getPendingTaskCount() Get the number of tasks waiting to be executed.
AsyncTaskPersister	getTaskPersister()
PriorityBlockingQueue<AsyncTask>	getTaskQueue()
boolean	hasPendingTaskWithCustomKey(String key) Has an unexecuted task with the given custom key
boolean	hasSeenTask(String id)
boolean	hasTaskWithCustomKey(String key) Has any task, pending or already run, with the given custom key
boolean	hasTaskWithId(Long id) Check to see if the task with the given id exists in the queue
protected boolean	lockTaskForExecution(AsyncTask task)
boolean	markCompleted(AsyncTask task) Mark the task as completed.
boolean	markFailed(AsyncTask task, Throwable throwable) Mark the task as failed.
void	onLoadTaskOnBoot(AsyncTask task) Called when a task is loaded from the data store during the boot phase.
void	saveNewTask(AsyncTask task) Save a new task to the data store
void	updateTask(AsyncTask task, boolean executeAtChanged) Update a task with new information.

Methods inherited from class io.stallion.asyncTasks.AsyncCoordinator

executeNext, executeNext, getExtraClassLoaders, gracefulShutdown, init, initAndStart, initEphemeralSynchronousForTests, initForTests, instance, isSynchronousMode, registerClassLoader, registerHandler, registerHandler, run, runTaskForId, shutDownForTests, startup

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncFileCoordinator

public AsyncFileCoordinator()

Method Detail

enqueue

public AsyncTask enqueue(AsyncTaskHandler handler)

Description copied from class: AsyncCoordinator

Enqueue a new task runner; a task object will automatically be created for this handler.

Specified by:

enqueue in class AsyncCoordinator

Returns:

enqueue

public AsyncTask enqueue(AsyncTaskHandler handler,
                         String customKey,
                         long executeAt)

Description copied from class: AsyncCoordinator

Enque a new task handler. CustomKey should be a globally unique key. It can be later used to update the task, or to prevent double enqueuing. For instance, if you were writing a calendar application, you might create a task to notify people 1 hour before each event. You could create a customKey with the user and event id in it. Then if the user changes the event time, you can use the customKey to find the task, and update it with a new executeAt time.

Specified by:

enqueue in class AsyncCoordinator

Parameters:

handler - - the task handler that will be executed.

customKey - - a user generated unique key that allows you to prevent dupes or later update the task

executeAt - - when you want the task to execute, in epoch milliseconds

Returns:

enqueue

public void enqueue(AsyncTask task)

Description copied from class: AsyncCoordinator

Enqueue a task object, normally you enqueue using task handler, which will then call this method.

Specified by:

enqueue in class AsyncCoordinator

updateTask

public void updateTask(AsyncTask task,
                       boolean executeAtChanged)

Description copied from class: AsyncCoordinator

Update a task with new information.

Specified by:

updateTask in class AsyncCoordinator

saveNewTask

public void saveNewTask(AsyncTask task)

Description copied from class: AsyncCoordinator

Save a new task to the data store

Specified by:

saveNewTask in class AsyncCoordinator

findAndLockNextTask

public AsyncTask findAndLockNextTask(Long now)

Description copied from class: AsyncCoordinator

Find the next task that is unlocked and ready for execution, lock it, and return it.

Specified by:

findAndLockNextTask in class AsyncCoordinator

Returns:

lockTaskForExecution

protected boolean lockTaskForExecution(AsyncTask task)

markCompleted

public boolean markCompleted(AsyncTask task)

Description copied from class: AsyncCoordinator

Mark the task as completed.

Specified by:

markCompleted in class AsyncCoordinator

Returns:

markFailed

public boolean markFailed(AsyncTask task,
                          Throwable throwable)

Description copied from class: AsyncCoordinator

Mark the task as failed.

Specified by:

markFailed in class AsyncCoordinator

Returns:

getTaskPersister

public AsyncTaskPersister getTaskPersister()

Specified by:

getTaskPersister in class AsyncCoordinator

hasSeenTask

public boolean hasSeenTask(String id)

hasTaskWithId

public boolean hasTaskWithId(Long id)

Description copied from class: AsyncCoordinator

Check to see if the task with the given id exists in the queue

Specified by:

hasTaskWithId in class AsyncCoordinator

Returns:

hasPendingTaskWithCustomKey

public boolean hasPendingTaskWithCustomKey(String key)

Description copied from class: AsyncCoordinator

Has an unexecuted task with the given custom key

Specified by:

hasPendingTaskWithCustomKey in class AsyncCoordinator

Returns:

hasTaskWithCustomKey

public boolean hasTaskWithCustomKey(String key)

Description copied from class: AsyncCoordinator

Has any task, pending or already run, with the given custom key

Specified by:

hasTaskWithCustomKey in class AsyncCoordinator

Returns:

getTaskQueue

public PriorityBlockingQueue<AsyncTask> getTaskQueue()

onLoadTaskOnBoot

public void onLoadTaskOnBoot(AsyncTask task)

Description copied from class: AsyncCoordinator

Called when a task is loaded from the data store during the boot phase.

Specified by:

onLoadTaskOnBoot in class AsyncCoordinator

getPendingTaskCount

public int getPendingTaskCount()

Description copied from class: AsyncCoordinator

Get the number of tasks waiting to be executed.

Specified by:

getPendingTaskCount in class AsyncCoordinator

Returns: