org.fusesource.hawtdispatch.internal

Class SerialDispatchQueue

java.lang.Object

org.fusesource.hawtdispatch.Task

org.fusesource.hawtdispatch.internal.BaseSuspendable

org.fusesource.hawtdispatch.internal.AbstractDispatchObject

org.fusesource.hawtdispatch.internal.SerialDispatchQueue

All Implemented Interfaces:

java.lang.Runnable, java.util.concurrent.Executor, DispatchObject, DispatchQueue, HawtDispatchQueue, Suspendable

public class SerialDispatchQueue
extends AbstractDispatchObject
implements HawtDispatchQueue

Nested Class Summary

Nested classes/interfaces inherited from interface org.fusesource.hawtdispatch.DispatchQueue

DispatchQueue.QueueType

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.ThreadLocal<java.lang.Boolean>	executing
protected java.util.concurrent.ConcurrentLinkedQueue<Task>	externalQueue
protected java.lang.String	label
private java.util.LinkedList<Task>	localQueue
private MetricsCollector	metricsCollector
private boolean	profile
private java.util.LinkedList<Task>	sourceQueue
protected java.util.concurrent.atomic.AtomicBoolean	triggered

Fields inherited from class org.fusesource.hawtdispatch.internal.AbstractDispatchObject

targetQueue

Fields inherited from class org.fusesource.hawtdispatch.internal.BaseSuspendable

startup, suspended

Constructor Summary

Constructors

Constructor and Description
SerialDispatchQueue(java.lang.String label)

Method Summary

Modifier and Type	Method and Description
void	assertExecuting() Asserts that the current dispatch queue is executing.
private void	checkCollector()
DispatchQueue	createQueue(java.lang.String label) Creates a new serial dispatch queue with this queue set as it's target queue.
private int	drains()
private void	enqueue(Task runnable)
void	execute(java.lang.Runnable runnable) Deprecated.
void	execute(Task task) Submits a task for asynchronous execution on a dispatch queue.
void	executeAfter(long delay, java.util.concurrent.TimeUnit unit, java.lang.Runnable runnable) Deprecated.
void	executeAfter(long delay, java.util.concurrent.TimeUnit unit, Task task) Schedule a task for execution on a given queue at a specified time.
HawtDispatcher	getDispatcher()
java.lang.String	getLabel() Returns the label of the queue.
DispatchQueue.QueueType	getQueueType()
java.util.LinkedList<Task>	getSourceQueue()
boolean	isExecuting() Returns true if this dispatch queue is executing the caller.
GlobalDispatchQueue	isGlobalDispatchQueue()
SerialDispatchQueue	isSerialDispatchQueue()
ThreadDispatchQueue	isThreadDispatchQueue()
Metrics	metrics() Returns the usage metrics of this queue.
protected void	onResume()
protected void	onStartup()
boolean	profile()
void	profile(boolean profile) Enables or disables profiler metric tracking on the queue.
void	run()
void	setLabel(java.lang.String label) Sets the label of the queue.
java.lang.String	toString()
protected void	triggerExecution()

Methods inherited from class org.fusesource.hawtdispatch.internal.AbstractDispatchObject

getTargetQueue, setTargetQueue

Methods inherited from class org.fusesource.hawtdispatch.internal.BaseSuspendable

isSuspended, onSuspend, resume, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fusesource.hawtdispatch.internal.HawtDispatchQueue

getTargetQueue

Methods inherited from interface org.fusesource.hawtdispatch.DispatchObject

setTargetQueue

Methods inherited from interface org.fusesource.hawtdispatch.Suspendable

isSuspended, resume, suspend

Field Detail

label

protected volatile java.lang.String label

triggered

protected final java.util.concurrent.atomic.AtomicBoolean triggered

externalQueue

protected final java.util.concurrent.ConcurrentLinkedQueue<Task> externalQueue

localQueue

private final java.util.LinkedList<Task> localQueue

sourceQueue

private final java.util.LinkedList<Task> sourceQueue

executing

private final java.lang.ThreadLocal<java.lang.Boolean> executing

metricsCollector

private MetricsCollector metricsCollector

profile

private boolean profile

Constructor Detail

SerialDispatchQueue

public SerialDispatchQueue(java.lang.String label)

Method Detail

execute

public void execute(Task task)

Description copied from interface: DispatchQueue

Submits a task for asynchronous execution on a dispatch queue.

DispatchQueue.execute(Task) is the fundamental mechanism for submitting runnable objects to a dispatch queue.

Calls to DispatchQueue.execute(Task) always return immediately after the runnable has been submitted, and never wait for the runnable to be executed.

The target queue determines whether the runnable will be invoked serially or concurrently with respect to other runnables submitted to that same queue. Serial queues are processed concurrently with with respect to each other.

Specified by:

execute in interface DispatchQueue

Parameters:

task - The task to submit to the dispatch queue.

execute

@Deprecated
public void execute(java.lang.Runnable runnable)

Deprecated.

Description copied from interface: DispatchQueue

Submits a runnable for asynchronous execution on a dispatch queue.

DispatchQueue.execute(Runnable) is the fundamental mechanism for submitting runnable objects to a dispatch queue.

Calls to DispatchQueue.execute(Runnable) always return immediately after the runnable has been submitted, and never wait for the runnable to be executed.

The target queue determines whether the runnable will be invoked serially or concurrently with respect to other runnables submitted to that same queue. Serial queues are processed concurrently with with respect to each other.

Specified by:

execute in interface java.util.concurrent.Executor

Specified by:

execute in interface DispatchQueue

Parameters:

runnable - The runnable to submit to the dispatch queue.

executeAfter

@Deprecated
public void executeAfter(long delay,
                                     java.util.concurrent.TimeUnit unit,
                                     java.lang.Runnable runnable)

Deprecated.

Description copied from interface: DispatchQueue

Schedule a runnable for execution on a given queue at a specified time.

Specified by:

executeAfter in interface DispatchQueue

Parameters:

delay - the amount of time to delay before executing the runnable

unit - the unit of time that the delay value is specified in

getSourceQueue

public java.util.LinkedList<Task> getSourceQueue()

Specified by:

getSourceQueue in interface HawtDispatchQueue

enqueue

private void enqueue(Task runnable)

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class BaseSuspendable

triggerExecution

protected void triggerExecution()

getLabel

public java.lang.String getLabel()

Description copied from interface: DispatchQueue

Returns the label of the queue.

Specified by:

getLabel in interface DispatchQueue

Returns:

the label of the queue. The result may be null.

setLabel

public void setLabel(java.lang.String label)

Description copied from interface: DispatchQueue

Sets the label of the queue.

Specified by:

setLabel in interface DispatchQueue

Parameters:

label - the label of the queue.

isExecuting

public boolean isExecuting()

Description copied from interface: DispatchQueue

Returns true if this dispatch queue is executing the caller.

Specified by:

isExecuting in interface DispatchQueue

Returns:

if this dispatch queue is executing the caller.

assertExecuting

public void assertExecuting()

Description copied from interface: DispatchQueue

Asserts that the current dispatch queue is executing.

Specified by:

assertExecuting in interface DispatchQueue

onStartup

protected void onStartup()

Overrides:

onStartup in class BaseSuspendable

onResume

protected void onResume()

Overrides:

onResume in class BaseSuspendable

getQueueType

public DispatchQueue.QueueType getQueueType()

Specified by:

getQueueType in interface DispatchQueue

Returns:

the type of dispatch queue that this object implements.

executeAfter

public void executeAfter(long delay,
                         java.util.concurrent.TimeUnit unit,
                         Task task)

Description copied from interface: DispatchQueue

Schedule a task for execution on a given queue at a specified time.

Specified by:

executeAfter in interface DispatchQueue

Parameters:

delay - the amount of time to delay before executing the runnable

unit - the unit of time that the delay value is specified in

createQueue

public DispatchQueue createQueue(java.lang.String label)

Description copied from interface: DispatchQueue

Creates a new serial dispatch queue with this queue set as it's target queue. See Dispatch.createQueue(String) for more information about serial dispatch queues.

Specified by:

createQueue in interface DispatchQueue

Parameters:

label - the label to assign the dispatch queue, can be null

Returns:

the newly created dispatch queue

getDispatcher

public HawtDispatcher getDispatcher()

Specified by:

getDispatcher in interface HawtDispatchQueue

isSerialDispatchQueue

public SerialDispatchQueue isSerialDispatchQueue()

Specified by:

isSerialDispatchQueue in interface HawtDispatchQueue

isThreadDispatchQueue

public ThreadDispatchQueue isThreadDispatchQueue()

Specified by:

isThreadDispatchQueue in interface HawtDispatchQueue

isGlobalDispatchQueue

public GlobalDispatchQueue isGlobalDispatchQueue()

Specified by:

isGlobalDispatchQueue in interface HawtDispatchQueue

profile

public void profile(boolean profile)

Description copied from interface: DispatchQueue

Enables or disables profiler metric tracking on the queue.

Specified by:

profile in interface DispatchQueue

profile

public boolean profile()

Specified by:

profile in interface DispatchQueue

Returns:

true is profiling is enabled.

checkCollector

private void checkCollector()

metrics

public Metrics metrics()

Description copied from interface: DispatchQueue

Returns the usage metrics of this queue. Only returns a value if the queue has profiling enabled.

Specified by:

metrics in interface DispatchQueue

Returns:

new metric counters accumulated since last called or null if the queue has not been used.

drains

private int drains()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object