com.inductiveautomation.ignition.common.util

Class SerialExecutionQueue<T>

java.lang.Object

com.inductiveautomation.ignition.common.util.SerialExecutionQueue<T>

Type Parameters:

T - Submitted item type.

public class SerialExecutionQueue<T>
extends java.lang.Object

Queues up submitted items and executes them in serial on an ExecutorService.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SerialExecutionQueue.ExecutionCallback<T>
static class	SerialExecutionQueue.RunnableExecutor An SerialExecutionQueue.ExecutionCallback that executes Runnables.

Field Summary

Fields

Modifier and Type	Field and Description
static SerialExecutionQueue.RunnableExecutor	RUNNABLE_EXECUTOR

Constructor Summary

Constructors

Constructor and Description
SerialExecutionQueue(SerialExecutionQueue.ExecutionCallback<T> callback, java.util.concurrent.ExecutorService service)

Method Summary

Modifier and Type	Method and Description
static <T> SerialExecutionQueue.ExecutionCallback<T>	noOpCallback()
void	pause() Pause evaluation of items in the queue.
void	resume() Resume evaluation of items in the queue.
void	submit(T item) Submit an item to be delivered to the callback when it's time to execute.
void	submitToHead(T item) Submit an item at the head of the queue to be delivered to the callback when it's time to execute.

Methods inherited from class java.lang.Object

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

Field Detail

RUNNABLE_EXECUTOR

public static final SerialExecutionQueue.RunnableExecutor RUNNABLE_EXECUTOR

Constructor Detail

SerialExecutionQueue

public SerialExecutionQueue(SerialExecutionQueue.ExecutionCallback<T> callback,
                            java.util.concurrent.ExecutorService service)

Method Detail

submit

public void submit(T item)

Submit an item to be delivered to the callback when it's time to execute.

Parameters:

item - Item to be delivered.

submitToHead

public void submitToHead(T item)

Submit an item at the head of the queue to be delivered to the callback when it's time to execute.

Parameters:

item - Item to be delivered.

pause

public void pause()

Pause evaluation of items in the queue.

resume

public void resume()

Resume evaluation of items in the queue.

noOpCallback

public static <T> SerialExecutionQueue.ExecutionCallback<T> noOpCallback()