com.inductiveautomation.ignition.common.util

Class ExecutionQueue

java.lang.Object

com.inductiveautomation.ignition.common.util.ExecutionQueue

public class ExecutionQueue
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
ExecutionQueue(java.util.concurrent.ExecutorService service)

Method Summary

Modifier and Type	Method and Description
boolean	isInQueue()
void	pause() Pause execution of queued Runnables.
void	requireInQueue() Call to check if the current code is being executed inside this queue.
void	requireInQueue(java.lang.String message) Call to check if the current code is being executed inside this queue.
void	resume() Resume execution of queued Runnables.
void	submit(java.lang.Runnable runnable) Submit a Runnable to be executed.
void	submitToHead(java.lang.Runnable runnable) Submit a Runnable to be executed at the head of the queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionQueue

public ExecutionQueue(java.util.concurrent.ExecutorService service)

Method Detail

submit

public void submit(java.lang.Runnable runnable)

Submit a Runnable to be executed.

Parameters:

runnable - the Runnable to be executed.

submitToHead

public void submitToHead(java.lang.Runnable runnable)

Submit a Runnable to be executed at the head of the queue.

Parameters:

runnable - the Runnable to be executed.

pause

public void pause()

Pause execution of queued Runnables.

resume

public void resume()

Resume execution of queued Runnables.

requireInQueue

public void requireInQueue()

Call to check if the current code is being executed inside this queue.

Throws:

java.lang.IllegalStateException - if flow reaches here without going through this queue

requireInQueue

public void requireInQueue(java.lang.String message)

Call to check if the current code is being executed inside this queue.

Parameters:

message - The message to use in the thrown exception if the check fails

Throws:

java.lang.IllegalStateException - if flow reaches here without going through this queue

isInQueue

public boolean isInQueue()