Index (hawtdispatch API Reference (1.22))

A B C D E G H I J L M N O P Q R S T U V

A

AggregatingExecutor - Class in org.fusesource.hawtdispatch: Sends runnable tasks to a DispatchQueue via a an EventAggregator so that they first batch up on the sender side before being sent to the DispatchQueue which then executes that tasks.
AggregatingExecutor(DispatchQueue) - Constructor for class org.fusesource.hawtdispatch.AggregatingExecutor
AnnotatedMBean - Class in org.fusesource.hawtdispatch.jmx: MBean that looks for method/parameter descriptions in the Info annotation.
AnnotatedMBean(T, Class<T>) - Constructor for class org.fusesource.hawtdispatch.jmx.AnnotatedMBean: Instance where the MBean interface is implemented by another object.
AnnotatedMBean(Class<?>) - Constructor for class org.fusesource.hawtdispatch.jmx.AnnotatedMBean: Instance where the MBean interface is implemented by this object.
assertExecuting() - Method in interface org.fusesource.hawtdispatch.DispatchQueue: Asserts that the current dispatch queue is executing.
assertRetained() - Method in class org.fusesource.hawtdispatch.BaseRetained: Subclasses can use this method to validate that the object has not yet been released.

B

BaseRetained - Class in org.fusesource.hawtdispatch: Base class that implements the Retained interface.
BaseRetained() - Constructor for class org.fusesource.hawtdispatch.BaseRetained

C

cancel() - Method in interface org.fusesource.hawtdispatch.DispatchSource: Asynchronously cancel the dispatch source, preventing any further invocation of its event handler runnable.
convert(Metrics, TimeUnit) - Static method in class org.fusesource.hawtdispatch.jmx.JmxService
create(Class<T>, T, DispatchQueue) - Static method in class org.fusesource.hawtdispatch.DispatchQueueProxy: Create an asynchronous dispatch proxy to the target object via the dispatch queue.
create(ClassLoader, Class<T>, T, DispatchQueue) - Static method in class org.fusesource.hawtdispatch.DispatchQueueProxy: Create an asynchronous dispatch proxy to the target object via the dispatch queue.
create(Object) - Static method in class org.fusesource.hawtdispatch.jmx.AnnotatedMBean
createQueue(String) - Static method in class org.fusesource.hawtdispatch.Dispatch: Creates a new serial dispatch queue to which runnable objects may be submitted.
createQueue() - Static method in class org.fusesource.hawtdispatch.Dispatch: Creates a new serial dispatch queue to which runnable objects may be submitted.
createQueue(String) - Method in interface org.fusesource.hawtdispatch.Dispatcher: Creates a new serial dispatch queue to which runnable objects may be submitted.
createQueue(String) - Method in interface org.fusesource.hawtdispatch.DispatchQueue: Creates a new serial dispatch queue with this queue set as it's target queue.
createSource(SelectableChannel, int, DispatchQueue) - Static method in class org.fusesource.hawtdispatch.Dispatch: Creates a new DispatchSource to monitor SelectableChannel objects and automatically submit a handler runnable to a dispatch queue in response to events.
createSource(EventAggregator<Event, MergedEvent>, DispatchQueue) - Static method in class org.fusesource.hawtdispatch.Dispatch: 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.
createSource(SelectableChannel, int, DispatchQueue) - Method in interface org.fusesource.hawtdispatch.Dispatcher: Creates a new DispatchSource to monitor SelectableChannel objects and automatically submit a handler runnable to a dispatch queue in response to events.
createSource(EventAggregator<Event, MergedEvent>, DispatchQueue) - Method in interface org.fusesource.hawtdispatch.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.
CustomDispatchSource<Event,MergedEvent> - Interface in org.fusesource.hawtdispatch: A dispatch source that is used to coalesce multiple application generated events for later processing by the dispatch source event handler.

D

DEFAULT - Static variable in class org.fusesource.hawtdispatch.Dispatch
dequeued - Variable in class org.fusesource.hawtdispatch.Metrics: The number of runnable tasks that have been removed from the queue and executed.
Dispatch - Class in org.fusesource.hawtdispatch: The Dispatch class is used to get or create dispatch objects such as global queues, thread queues, serial queues, or dispatch sources.
Dispatch() - Constructor for class org.fusesource.hawtdispatch.Dispatch
Dispatcher - Interface in org.fusesource.hawtdispatch: The Dispatcher interface is used to get or create dispatch objects such as global queues, thread queues, serial queues, or dispatch sources.
DISPATCHER_OBJECT_NAME - Static variable in class org.fusesource.hawtdispatch.jmx.JmxService
DispatchObject - Interface in org.fusesource.hawtdispatch: Implemented by dispatch objects that can be configured with a target queue that it uses for executing the object's asynchronous tasks.
DispatchPriority - Enum in org.fusesource.hawtdispatch: Defines the supported global/concurrent queue priorities.
DispatchQueue - Interface in org.fusesource.hawtdispatch: Dispatch queues are lightweight objects to which runnable objects may be submitted for asynchronous execution and therefore are Executor objects.
DispatchQueue.QueueType - Enum in org.fusesource.hawtdispatch: Defines the types of dispatch queues supported by the system.
DispatchQueueProxy - Class in org.fusesource.hawtdispatch: This class creates proxy objects that allow you to easily service all method calls to an interface via a DispatchQueue.
DispatchQueueProxy() - Constructor for class org.fusesource.hawtdispatch.DispatchQueueProxy
DispatchSource - Interface in org.fusesource.hawtdispatch: A dispatch source is used to monitor low-level system objects and automatically submit a handler runnable to a dispatch queue in response to events.
dispose() - Method in class org.fusesource.hawtdispatch.BaseRetained: This method will be called once the release retained reaches zero.
durationNS - Variable in class org.fusesource.hawtdispatch.Metrics: How long the metrics gathered

E

enqueued - Variable in class org.fusesource.hawtdispatch.Metrics: The number of runnable tasks queued.
equals(Object) - Method in class org.fusesource.hawtdispatch.TaskWrapper
EventAggregator<Event,MergedEvent> - Interface in org.fusesource.hawtdispatch: The EventAggregator interface is used by the CustomDispatchSource objects to handle coalescing data before passing it to the application.
EventAggregators - Class in org.fusesource.hawtdispatch
EventAggregators() - Constructor for class org.fusesource.hawtdispatch.EventAggregators
execute(Runnable) - Method in class org.fusesource.hawtdispatch.AggregatingExecutor
execute(Runnable) - Method in interface org.fusesource.hawtdispatch.DispatchQueue: Submits a runnable for asynchronous execution on a dispatch queue.
execute(Task) - Method in interface org.fusesource.hawtdispatch.DispatchQueue: Submits a task for asynchronous execution on a dispatch queue.
executeAfter(long, TimeUnit, Runnable) - Method in interface org.fusesource.hawtdispatch.DispatchQueue: Schedule a runnable for execution on a given queue at a specified time.
executeAfter(long, TimeUnit, Task) - Method in interface org.fusesource.hawtdispatch.DispatchQueue: Schedule a task for execution on a given queue at a specified time.

G

getCurrentQueue() - Static method in class org.fusesource.hawtdispatch.Dispatch: Returns the queue on which the currently executing runnable is running.
getCurrentQueue() - Method in interface org.fusesource.hawtdispatch.Dispatcher: Returns the queue on which the currently executing runnable is running.
getCurrentThreadQueue() - Static method in class org.fusesource.hawtdispatch.Dispatch
getCurrentThreadQueue() - Method in interface org.fusesource.hawtdispatch.Dispatcher
getData() - Method in interface org.fusesource.hawtdispatch.CustomDispatchSource: Returns pending data for the dispatch source.
getDescription(MBeanAttributeInfo) - Method in class org.fusesource.hawtdispatch.jmx.AnnotatedMBean
getDescription(MBeanOperationInfo) - Method in class org.fusesource.hawtdispatch.jmx.AnnotatedMBean
getDisposer() - Method in class org.fusesource.hawtdispatch.BaseRetained
getGlobalQueue() - Static method in class org.fusesource.hawtdispatch.Dispatch: Returns the global concurrent queue of default priority.
getGlobalQueue(DispatchPriority) - Static method in class org.fusesource.hawtdispatch.Dispatch: Returns a well-known global concurrent queue of a given priority level.
getGlobalQueue() - Method in interface org.fusesource.hawtdispatch.Dispatcher: Returns the global concurrent queue of default priority.
getGlobalQueue(DispatchPriority) - Method in interface org.fusesource.hawtdispatch.Dispatcher: Returns a well-known global concurrent queue of a given priority level.
getLabel() - Method in interface org.fusesource.hawtdispatch.DispatchQueue: Returns the label of the queue.
getMetrics() - Method in class org.fusesource.hawtdispatch.jmx.JmxService.JmxDispatcher
getMetrics() - Method in interface org.fusesource.hawtdispatch.jmx.JmxService.JmxDispatcherMBean
getParameterName(MBeanOperationInfo, MBeanParameterInfo, int) - Method in class org.fusesource.hawtdispatch.jmx.AnnotatedMBean
getProfile() - Method in class org.fusesource.hawtdispatch.jmx.JmxService.JmxDispatcher
getProfile() - Method in interface org.fusesource.hawtdispatch.jmx.JmxService.JmxDispatcherMBean
getQueueType() - Method in interface org.fusesource.hawtdispatch.DispatchQueue
getTargetQueue() - Method in interface org.fusesource.hawtdispatch.DispatchObject: Gets the target queue for this object.
getThreadQueues(DispatchPriority) - Static method in class org.fusesource.hawtdispatch.Dispatch
getThreadQueues(DispatchPriority) - Method in interface org.fusesource.hawtdispatch.Dispatcher
getTimeUnit() - Method in class org.fusesource.hawtdispatch.jmx.JmxService.JmxDispatcher
getTimeUnit() - Method in interface org.fusesource.hawtdispatch.jmx.JmxService.JmxDispatcherMBean

H

hashCode() - Method in class org.fusesource.hawtdispatch.TaskWrapper
hashSet() - Static method in class org.fusesource.hawtdispatch.EventAggregators: An EventAggregator that coalesces object data obtained via calls to CustomDispatchSource.merge(Object) into a hash set.
HIGH - Static variable in class org.fusesource.hawtdispatch.Dispatch

I

INTEGER_ADD - Static variable in class org.fusesource.hawtdispatch.EventAggregators: An EventAggregator that coalesces integer data obtained via calls to CustomDispatchSource.merge(Object).
INTEGER_OR - Static variable in class org.fusesource.hawtdispatch.EventAggregators: An EventAggregator that coalesces integer data obtained via calls to CustomDispatchSource.merge(Object).
isCanceled() - Method in interface org.fusesource.hawtdispatch.DispatchSource
isExecuting() - Method in interface org.fusesource.hawtdispatch.DispatchQueue: Returns true if this dispatch queue is executing the caller.
isSuspended() - Method in interface org.fusesource.hawtdispatch.Suspendable

J

JmxService - Class in org.fusesource.hawtdispatch.jmx
JmxService() - Constructor for class org.fusesource.hawtdispatch.jmx.JmxService
JmxService.JmxDispatcher - Class in org.fusesource.hawtdispatch.jmx
JmxService.JmxDispatcher(Dispatcher) - Constructor for class org.fusesource.hawtdispatch.jmx.JmxService.JmxDispatcher
JmxService.JmxDispatcherMBean - Interface in org.fusesource.hawtdispatch.jmx

L

linkedList() - Static method in class org.fusesource.hawtdispatch.EventAggregators: An EventAggregator that coalesces object data obtained via calls to CustomDispatchSource.merge(Object) into a linked list.
LONG_ADD - Static variable in class org.fusesource.hawtdispatch.EventAggregators: An EventAggregator that coalesces long data obtained via calls to CustomDispatchSource.merge(Object).
LONG_OR - Static variable in class org.fusesource.hawtdispatch.EventAggregators: An EventAggregator that coalesces long data obtained via calls to CustomDispatchSource.merge(Object).
LOW - Static variable in class org.fusesource.hawtdispatch.Dispatch

M

maxRunTimeNS - Variable in class org.fusesource.hawtdispatch.Metrics: The long amount of time a runnable task spent executing in nanoseconds.
maxWaitTimeNS - Variable in class org.fusesource.hawtdispatch.Metrics: The longest amount of time at runnable task spent waiting in the queue.
MBeanInfo - Annotation Type in org.fusesource.hawtdispatch.jmx
merge(Event) - Method in interface org.fusesource.hawtdispatch.CustomDispatchSource: Merges data into a dispatch source and submits its event handler runnable to its target queue.
mergeEvent(MergedEvent, Event) - Method in interface org.fusesource.hawtdispatch.EventAggregator: Merge the given event with the previous event values.
mergeEvents(MergedEvent, MergedEvent) - Method in interface org.fusesource.hawtdispatch.EventAggregator: Merge the given events with the previous event values.
metrics() - Static method in class org.fusesource.hawtdispatch.Dispatch: Used to get profiling metrics for all the queues currently being profiled.
metrics() - Method in interface org.fusesource.hawtdispatch.Dispatcher: Used to get profiling metrics for all the queues currently being profiled.
metrics() - Method in interface org.fusesource.hawtdispatch.DispatchQueue: Returns the usage metrics of this queue.
Metrics - Class in org.fusesource.hawtdispatch
Metrics() - Constructor for class org.fusesource.hawtdispatch.Metrics

N

NOOP - Static variable in class org.fusesource.hawtdispatch.Dispatch: A Runnable task that does nothing.

O

objectName(HawtDispatcher) - Static method in class org.fusesource.hawtdispatch.jmx.JmxService
OrderedEventAggregator<Event,MergedEvent> - Interface in org.fusesource.hawtdispatch: This class should be implemented by Aggregator classes which depend on FIFO ordering of events from the point of view of the serial queue which merges events into it.
org.fusesource.hawtdispatch - package org.fusesource.hawtdispatch: HawtDispatch HawtDispatch is an abstract model for expressing concurrency via simple but powerful API.
org.fusesource.hawtdispatch.jmx - package org.fusesource.hawtdispatch.jmx

P

profile(boolean) - Static method in class org.fusesource.hawtdispatch.Dispatch: If enabled then it enables profiling on the global queues and any newly created queues.
profile(boolean) - Method in interface org.fusesource.hawtdispatch.Dispatcher: If enabled then it enables profiling on the global queues and any newly created queues.
profile() - Method in interface org.fusesource.hawtdispatch.Dispatcher
profile(boolean) - Method in interface org.fusesource.hawtdispatch.DispatchQueue: Enables or disables profiler metric tracking on the queue.
profile() - Method in interface org.fusesource.hawtdispatch.DispatchQueue

Q

queue - Variable in class org.fusesource.hawtdispatch.Metrics: The dispatch queue associated with the metrics collected.

R

register(HawtDispatcher) - Static method in class org.fusesource.hawtdispatch.jmx.JmxService
release() - Method in class org.fusesource.hawtdispatch.BaseRetained: Decrement the reference count of this object.
release(int) - Method in class org.fusesource.hawtdispatch.BaseRetained: Decrements the reference count by n.
release() - Method in interface org.fusesource.hawtdispatch.Retained: Decrement the reference count of this object.
restart() - Static method in class org.fusesource.hawtdispatch.Dispatch: Restart default dispatcher instance.
restart() - Method in interface org.fusesource.hawtdispatch.Dispatcher: Restart this dispatcher instance.
resume() - Method in class org.fusesource.hawtdispatch.AggregatingExecutor
resume() - Method in interface org.fusesource.hawtdispatch.Suspendable: Resumes the invocation of tasks on a dispatch object.
retain() - Method in class org.fusesource.hawtdispatch.BaseRetained: Increment the reference count of this object.
retain() - Method in interface org.fusesource.hawtdispatch.Retained: Increment the reference count of this object.
retained() - Method in class org.fusesource.hawtdispatch.BaseRetained
Retained - Interface in org.fusesource.hawtdispatch: Implemented by dispatch objects which use a reference counted life cycle.
retained() - Method in interface org.fusesource.hawtdispatch.Retained
run() - Method in class org.fusesource.hawtdispatch.Task
run() - Method in class org.fusesource.hawtdispatch.TaskWrapper

S

setCancelHandler(Runnable) - Method in interface org.fusesource.hawtdispatch.DispatchSource: Sets the cancellation handler runnable for the given dispatch source.
setCancelHandler(Task) - Method in interface org.fusesource.hawtdispatch.DispatchSource: Sets the cancellation handler task for the given dispatch source.
setDisposer(Runnable) - Method in class org.fusesource.hawtdispatch.BaseRetained: Adds a disposer runnable that is executed once the object is disposed.
setDisposer(Task) - Method in class org.fusesource.hawtdispatch.BaseRetained: Adds a disposer runnable that is executed once the object is disposed.
setEventHandler(Runnable) - Method in interface org.fusesource.hawtdispatch.DispatchSource: Sets the event handler runnable of this dispatch source.
setEventHandler(Task) - Method in interface org.fusesource.hawtdispatch.DispatchSource: Sets the event handler task of this dispatch source.
setLabel(String) - Method in interface org.fusesource.hawtdispatch.DispatchQueue: Sets the label of the queue.
setProfile(boolean) - Method in class org.fusesource.hawtdispatch.jmx.JmxService.JmxDispatcher
setProfile(boolean) - Method in interface org.fusesource.hawtdispatch.jmx.JmxService.JmxDispatcherMBean
setTargetQueue(DispatchQueue) - Method in interface org.fusesource.hawtdispatch.DispatchObject: Sets the target queue for this object.
setTimeUnit(String) - Method in class org.fusesource.hawtdispatch.jmx.JmxService.JmxDispatcher
setTimeUnit(String) - Method in interface org.fusesource.hawtdispatch.jmx.JmxService.JmxDispatcherMBean
shutdown() - Static method in class org.fusesource.hawtdispatch.Dispatch: Shutdown default dispatcher instance.
shutdown() - Method in interface org.fusesource.hawtdispatch.Dispatcher: Shutdown this dispatcher instance.
ShutdownException - Exception in org.fusesource.hawtdispatch: This exception is thrown when you attempt to use a dispatch object after the dispatch system has been shutdown in OSGi.
ShutdownException() - Constructor for exception org.fusesource.hawtdispatch.ShutdownException
ShutdownException(Throwable) - Constructor for exception org.fusesource.hawtdispatch.ShutdownException
ShutdownException(String, Throwable) - Constructor for exception org.fusesource.hawtdispatch.ShutdownException
ShutdownException(String) - Constructor for exception org.fusesource.hawtdispatch.ShutdownException
suspend() - Method in class org.fusesource.hawtdispatch.AggregatingExecutor
suspend() - Method in interface org.fusesource.hawtdispatch.Suspendable: Suspends the invocation of tasks on a dispatch object.
Suspendable - Interface in org.fusesource.hawtdispatch: Implemented by dispatch objects which can suspend the execution of dispatch tasks.

T

Task - Class in org.fusesource.hawtdispatch: We prefer the use of Task over Runnable since the JVM can more efficiently invoke methods of an abstract class than a interface.
Task() - Constructor for class org.fusesource.hawtdispatch.Task
TaskWrapper - Class in org.fusesource.hawtdispatch
TaskWrapper(Runnable) - Constructor for class org.fusesource.hawtdispatch.TaskWrapper
toString() - Method in class org.fusesource.hawtdispatch.Metrics
toString() - Method in class org.fusesource.hawtdispatch.TaskWrapper
totalRunTimeNS - Variable in class org.fusesource.hawtdispatch.Metrics: The sum of all the time spent executing tasks in nanoseconds.
totalWaitTimeNS - Variable in class org.fusesource.hawtdispatch.Metrics: The sum of all the time that tasks spent waiting in the queue in nanoseconds.

U

unregister(HawtDispatcher) - Static method in class org.fusesource.hawtdispatch.jmx.JmxService

V

valueOf(String) - Static method in enum org.fusesource.hawtdispatch.DispatchPriority: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.fusesource.hawtdispatch.DispatchQueue.QueueType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.fusesource.hawtdispatch.DispatchPriority: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.fusesource.hawtdispatch.DispatchQueue.QueueType: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G H I J L M N O P Q R S T U V