org.fusesource.hawtdispatch.internal

Class GlobalDispatchQueue

java.lang.Object

org.fusesource.hawtdispatch.internal.GlobalDispatchQueue

All Implemented Interfaces:

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

public final class GlobalDispatchQueue
extends java.lang.Object
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
HawtDispatcher	dispatcher
(package private) java.lang.String	label
private DispatchPriority	priority
(package private) WorkerPool	workers

Constructor Summary

Constructors

Constructor and Description
GlobalDispatchQueue(HawtDispatcher dispatcher, DispatchPriority priority, int threads)

Method Summary

Modifier and Type	Method and Description
void	assertExecuting() Asserts that the current dispatch queue is executing.
DispatchQueue	createQueue(java.lang.String label) Creates a new serial dispatch queue with this queue set as it's target queue.
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.
DispatchPriority	getPriority()
DispatchQueue.QueueType	getQueueType()
java.util.LinkedList<Task>	getSourceQueue()
ThreadDispatchQueue	getTargetQueue() Gets the target queue for this object.
(package private) DispatchQueue[]	getThreadQueues()
boolean	isExecuting() Returns true if this dispatch queue is executing the caller.
GlobalDispatchQueue	isGlobalDispatchQueue()
SerialDispatchQueue	isSerialDispatchQueue()
boolean	isSuspended()
ThreadDispatchQueue	isThreadDispatchQueue()
Metrics	metrics() Returns the usage metrics of this queue.
boolean	profile()
void	profile(boolean profile) Enables or disables profiler metric tracking on the queue.
void	resume() Resumes the invocation of tasks on a dispatch object.
void	setLabel(java.lang.String label) Sets the label of the queue.
void	setTargetQueue(DispatchQueue queue) Sets the target queue for this object.
void	shutdown()
void	start()
void	suspend() Suspends the invocation of tasks on a dispatch object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

dispatcher

public final HawtDispatcher dispatcher

label

volatile java.lang.String label

priority

private final DispatchPriority priority

workers

final WorkerPool workers

Constructor Detail

GlobalDispatchQueue

public GlobalDispatchQueue(HawtDispatcher dispatcher,
                           DispatchPriority priority,
                           int threads)

Method Detail

start

public void start()

shutdown

public void shutdown()

getDispatcher

public HawtDispatcher getDispatcher()

Specified by:

getDispatcher in interface HawtDispatchQueue

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.

getSourceQueue

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

Specified by:

getSourceQueue in interface HawtDispatchQueue

assertExecuting

public void assertExecuting()

Description copied from interface: DispatchQueue

Asserts that the current dispatch queue is executing.

Specified by:

assertExecuting in interface DispatchQueue

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

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.

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

getTargetQueue

public ThreadDispatchQueue getTargetQueue()

Description copied from interface: DispatchObject

Gets the target queue for this object.

Specified by:

getTargetQueue in interface DispatchObject

Specified by:

getTargetQueue in interface HawtDispatchQueue

Returns:

the target queue of this object.

See Also:

DispatchObject.setTargetQueue(DispatchQueue)

getPriority

public DispatchPriority getPriority()

resume

public void resume()

Description copied from interface: Suspendable

Resumes the invocation of tasks on a dispatch object.

Specified by:

resume in interface Suspendable

See Also:

Suspendable.suspend()

suspend

public void suspend()

Description copied from interface: Suspendable

Suspends the invocation of tasks on a dispatch object.

A suspended object will not invoke any tasks associated with it. The suspension of an object will occur after any running runnable associated with the object completes.

Calls to Suspendable.suspend() must be balanced with calls to Suspendable.resume().

Specified by:

suspend in interface Suspendable

See Also:

Suspendable.resume()

isSuspended

public boolean isSuspended()

Specified by:

isSuspended in interface Suspendable

Returns:

true if the the current object is suspended.

See Also:

Suspendable.resume(), Suspendable.suspend()

setTargetQueue

public void setTargetQueue(DispatchQueue queue)

Description copied from interface: DispatchObject

Sets the target queue for this object.

An object's target queue is responsible for processing the object.

A dispatch queue's priority is inherited by its target queue. Use the Dispatch.getGlobalQueue() method to obtain suitable target queue of the desired priority.

A dispatch source's target queue specifies where its event handler and cancellation handler runnables will be submitted.

Specified by:

setTargetQueue in interface DispatchObject

Parameters:

queue - The new target queue for the object. The queue is retained, and the previous one, if any, is released. The result of passing NULL in this parameter is undefined.

isGlobalDispatchQueue

public GlobalDispatchQueue isGlobalDispatchQueue()

Specified by:

isGlobalDispatchQueue in interface HawtDispatchQueue

isSerialDispatchQueue

public SerialDispatchQueue isSerialDispatchQueue()

Specified by:

isSerialDispatchQueue in interface HawtDispatchQueue

isThreadDispatchQueue

public ThreadDispatchQueue isThreadDispatchQueue()

Specified by:

isThreadDispatchQueue in interface HawtDispatchQueue

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

getQueueType

public DispatchQueue.QueueType getQueueType()

Specified by:

getQueueType in interface DispatchQueue

Returns:

the type of dispatch queue that this object implements.

getThreadQueues

DispatchQueue[] getThreadQueues()

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.

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.