org.fusesource.hawtdispatch.internal

Class HawtDispatcher

java.lang.Object

org.fusesource.hawtdispatch.internal.HawtDispatcher

All Implemented Interfaces:

Dispatcher

public final class HawtDispatcher
extends java.lang.Object
implements Dispatcher

Implements a simple dispatch system.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.ThreadLocal<HawtDispatchQueue>	CURRENT_QUEUE
(package private) GlobalDispatchQueue	DEFAULT_QUEUE
(package private) int	drains
private java.lang.Object	HIGH_MUTEX
private GlobalDispatchQueue	HIGH_QUEUE
(package private) boolean	jmx
private java.lang.String	label
private java.lang.Object	LOW_MUTEX
private GlobalDispatchQueue	LOW_QUEUE
private boolean	profile
static java.util.WeakHashMap<HawtDispatchQueue,java.lang.Object>	queues
(package private) java.util.concurrent.atomic.AtomicInteger	shutdownState
private int	threads
(package private) TimerThread	timerThread
(package private) java.lang.Thread.UncaughtExceptionHandler	uncaughtExceptionHandler

Constructor Summary

Constructors

Constructor and Description
HawtDispatcher(DispatcherConfig config)

Method Summary

Modifier and Type	Method and Description
(package private) java.lang.String	assertMessage(java.lang.String label)
SerialDispatchQueue	createQueue(java.lang.String label) Creates a new serial dispatch queue to which runnable objects may be submitted.
<Event,MergedEvent> CustomDispatchSource<Event,MergedEvent>	createSource(EventAggregator<Event,MergedEvent> aggregator, DispatchQueue queue) Creates a new CustomDispatchSource to monitor events merged into the dispatch source and automatically submit a handler runnable to a dispatch queue in response to the events.
DispatchSource	createSource(java.nio.channels.SelectableChannel channel, int interestOps, DispatchQueue queue) Creates a new DispatchSource to monitor SelectableChannel objects and automatically submit a handler runnable to a dispatch queue in response to events.
DispatchQueue	getCurrentQueue() Returns the queue on which the currently executing runnable is running.
ThreadDispatchQueue	getCurrentThreadQueue()
DispatchQueue	getGlobalQueue() Returns the global concurrent queue of default priority.
GlobalDispatchQueue	getGlobalQueue(DispatchPriority priority) Returns a well-known global concurrent queue of a given priority level.
java.lang.String	getLabel()
DispatchQueue[]	getThreadQueues(DispatchPriority priority)
java.lang.Thread.UncaughtExceptionHandler	getUncaughtExceptionHandler()
java.util.List<Metrics>	metrics() Used to get profiling metrics for all the queues currently being profiled.
boolean	profile()
void	profile(boolean on) If enabled then it enables profiling on the global queues and any newly created queues.
void	restart() Restart this dispatcher instance.
void	setUncaughtExceptionHandler(java.lang.Thread.UncaughtExceptionHandler uncaughtExceptionHandler)
void	shutdown() Shutdown this dispatcher instance.
private void	sleep(long time)
(package private) void	track(HawtDispatchQueue queue)
(package private) void	untrack(HawtDispatchQueue queue)

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_QUEUE

public static final java.lang.ThreadLocal<HawtDispatchQueue> CURRENT_QUEUE

DEFAULT_QUEUE

final GlobalDispatchQueue DEFAULT_QUEUE

HIGH_MUTEX

private final java.lang.Object HIGH_MUTEX

HIGH_QUEUE

private GlobalDispatchQueue HIGH_QUEUE

LOW_MUTEX

private final java.lang.Object LOW_MUTEX

LOW_QUEUE

private GlobalDispatchQueue LOW_QUEUE

label

private final java.lang.String label

timerThread

volatile TimerThread timerThread

threads

private final int threads

profile

private volatile boolean profile

drains

final int drains

jmx

final boolean jmx

shutdownState

final java.util.concurrent.atomic.AtomicInteger shutdownState

uncaughtExceptionHandler

volatile java.lang.Thread.UncaughtExceptionHandler uncaughtExceptionHandler

queues

public static final java.util.WeakHashMap<HawtDispatchQueue,java.lang.Object> queues

Constructor Detail

HawtDispatcher

public HawtDispatcher(DispatcherConfig config)

Method Detail

shutdown

public void shutdown()

Description copied from interface: Dispatcher

Shutdown this dispatcher instance.

Specified by:

shutdown in interface Dispatcher

sleep

private void sleep(long time)

restart

public void restart()

Description copied from interface: Dispatcher

Restart this dispatcher instance.

Specified by:

restart in interface Dispatcher

getGlobalQueue

public DispatchQueue getGlobalQueue()

Description copied from interface: Dispatcher

Returns the global concurrent queue of default priority.

Specified by:

getGlobalQueue in interface Dispatcher

Returns:

the default priority global queue.

See Also:

Dispatcher.getGlobalQueue(DispatchPriority)

getGlobalQueue

public GlobalDispatchQueue getGlobalQueue(DispatchPriority priority)

Description copied from interface: Dispatcher

Returns a well-known global concurrent queue of a given priority level.

The well-known global concurrent queues may not be modified. Calls to Suspendable.suspend(), Suspendable.resume(), etc., will have no effect when used with queues returned by this function.

Specified by:

getGlobalQueue in interface Dispatcher

Parameters:

priority - A priority defined in dispatch_queue_priority_t

Returns:

the requested global queue.

createQueue

public SerialDispatchQueue createQueue(java.lang.String label)

Description copied from interface: Dispatcher

Creates a new serial dispatch queue to which runnable objects may be submitted.

Serial dispatch queues execute runnables submitted to them serially in FIFO order. A queue will only invoke one runnable at a time, but independent queues may each execute their runnables concurrently with respect to each other.

Conceptually a dispatch queue may have its own thread of execution, and interaction between queues is highly asynchronous.

Specified by:

createQueue in interface Dispatcher

Parameters:

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

Returns:

the newly created dispatch queue

createSource

public DispatchSource createSource(java.nio.channels.SelectableChannel channel,
                                   int interestOps,
                                   DispatchQueue queue)

Description copied from interface: Dispatcher

Creates a new DispatchSource to monitor SelectableChannel objects and automatically submit a handler runnable to a dispatch queue in response to events.

You are allowed to create multiple dispatch sources to the same SelectableChannel object.

Specified by:

createSource in interface Dispatcher

Parameters:

channel - the channel to monitor.

interestOps - A mask of interest ops (SelectionKey.OP_ACCEPT, SelectionKey.OP_CONNECT, SelectionKey.OP_READ, or SelectionKey.OP_WRITE) specifying which events are desired.

queue - The dispatch queue to which the event handler tasks will be submited.

Returns:

the newly created DispatchSource

createSource

public <Event,MergedEvent> CustomDispatchSource<Event,MergedEvent> createSource(EventAggregator<Event,MergedEvent> aggregator,
                                                                                DispatchQueue queue)

Description copied from interface: Dispatcher

Creates a new CustomDispatchSource to monitor events merged into the dispatch source and automatically submit a handler runnable to a dispatch queue in response to the events.

Specified by:

createSource in interface Dispatcher

Parameters:

aggregator - the data aggregation strategy to use.

queue - The dispatch queue to which the event handler tasks will be submited.

Returns:

the newly created CustomDispatchSource

getLabel

public java.lang.String getLabel()

getCurrentQueue

public DispatchQueue getCurrentQueue()

Description copied from interface: Dispatcher

Returns the queue on which the currently executing runnable is running.

When Dispatcher.getCurrentQueue() is called outside of the context of a submitted runnable, it will return null.

Specified by:

getCurrentQueue in interface Dispatcher

Returns:

the queue on which the currently executing runnable is running.

getCurrentThreadQueue

public ThreadDispatchQueue getCurrentThreadQueue()

Specified by:

getCurrentThreadQueue in interface Dispatcher

Returns:

the current thread queue or null of not executing on a thread queue.

getThreadQueues

public DispatchQueue[] getThreadQueues(DispatchPriority priority)

Specified by:

getThreadQueues in interface Dispatcher

Returns:

the thread level dispatch queues for a given dispatch priority.

track

void track(HawtDispatchQueue queue)

untrack

void untrack(HawtDispatchQueue queue)

profile

public void profile(boolean on)

Description copied from interface: Dispatcher

If enabled then it enables profiling on the global queues and any newly created queues. If not enabled then it disables profiling support on all the currently profiled queues and any queues created in the future.

Specified by:

profile in interface Dispatcher

profile

public boolean profile()

Specified by:

profile in interface Dispatcher

Returns:

true is profiling is enabled.

metrics

public java.util.List<Metrics> metrics()

Description copied from interface: Dispatcher

Used to get profiling metrics for all the queues currently being profiled.

Specified by:

metrics in interface Dispatcher

Returns:

assertMessage

java.lang.String assertMessage(java.lang.String label)

getUncaughtExceptionHandler

public java.lang.Thread.UncaughtExceptionHandler getUncaughtExceptionHandler()

setUncaughtExceptionHandler

public void setUncaughtExceptionHandler(java.lang.Thread.UncaughtExceptionHandler uncaughtExceptionHandler)