org.fusesource.hawtdispatch.internal

Class HawtCustomDispatchSource<Event,MergedEvent>

java.lang.Object

org.fusesource.hawtdispatch.Task

org.fusesource.hawtdispatch.internal.BaseSuspendable

org.fusesource.hawtdispatch.internal.AbstractDispatchObject

org.fusesource.hawtdispatch.internal.HawtCustomDispatchSource<Event,MergedEvent>

All Implemented Interfaces:

java.lang.Runnable, CustomDispatchSource<Event,MergedEvent>, DispatchObject, DispatchSource, Suspendable

public final class HawtCustomDispatchSource<Event,MergedEvent>
extends AbstractDispatchObject
implements CustomDispatchSource<Event,MergedEvent>

Field Summary

Fields

Modifier and Type	Field and Description
private EventAggregator<Event,MergedEvent>	aggregator
(package private) java.util.concurrent.atomic.AtomicBoolean	canceled
private Task	cancelHandler
static boolean	DEBUG
private Task	eventHandler
protected java.util.concurrent.ConcurrentLinkedQueue<MergedEvent>	externalQueue
private java.lang.ThreadLocal<MergedEvent>	firedEvent
private boolean	ordered
private java.lang.ThreadLocal<MergedEvent>	outboundEvent
private MergedEvent	pendingEvent
protected java.util.concurrent.atomic.AtomicLong	size

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
HawtCustomDispatchSource(HawtDispatcher dispatcher, EventAggregator<Event,MergedEvent> aggregator, DispatchQueue queue)

Method Summary

Modifier and Type	Method and Description
void	cancel() Asynchronously cancel the dispatch source, preventing any further invocation of its event handler runnable.
protected void	debug(java.lang.String str, java.lang.Object... args)
protected void	debug(java.lang.Throwable thrown, java.lang.String str, java.lang.Object... args)
private void	fireEvent(MergedEvent event)
MergedEvent	getData() Returns pending data for the dispatch source.
boolean	isCanceled()
void	merge(Event event) Merges data into a dispatch source and submits its event handler runnable to its target queue.
protected void	onResume()
protected void	onStartup()
void	run()
void	setCancelHandler(java.lang.Runnable handler) Deprecated.
void	setCancelHandler(Task cancelHandler) Sets the cancellation handler task for the given dispatch source.
void	setEventHandler(java.lang.Runnable handler) Deprecated.
void	setEventHandler(Task eventHandler) Sets the event handler task of this dispatch source.

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, toString, wait, wait, wait

Methods inherited from interface org.fusesource.hawtdispatch.DispatchObject

getTargetQueue, setTargetQueue

Methods inherited from interface org.fusesource.hawtdispatch.Suspendable

isSuspended, resume, suspend

Field Detail

DEBUG

public static final boolean DEBUG

See Also:

Constant Field Values

canceled

final java.util.concurrent.atomic.AtomicBoolean canceled

cancelHandler

private Task cancelHandler

eventHandler

private Task eventHandler

outboundEvent

private final java.lang.ThreadLocal<MergedEvent> outboundEvent

firedEvent

private final java.lang.ThreadLocal<MergedEvent> firedEvent

aggregator

private final EventAggregator<Event,MergedEvent> aggregator

pendingEvent

private MergedEvent pendingEvent

ordered

private final boolean ordered

externalQueue

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

size

protected final java.util.concurrent.atomic.AtomicLong size

Constructor Detail

HawtCustomDispatchSource

public HawtCustomDispatchSource(HawtDispatcher dispatcher,
                                EventAggregator<Event,MergedEvent> aggregator,
                                DispatchQueue queue)

Method Detail

getData

public MergedEvent getData()

Description copied from interface: CustomDispatchSource

Returns pending data for the dispatch source. Calling this method consumes the event and a subsequent call will return null.

This function is intended to be called from within the event handler runnable. The result of calling this function outside of the event handler runnable is undefined.

Specified by:

getData in interface CustomDispatchSource<Event,MergedEvent>

merge

public void merge(Event event)

Description copied from interface: CustomDispatchSource

Merges data into a dispatch source and submits its event handler runnable to its target queue.

Specified by:

merge in interface CustomDispatchSource<Event,MergedEvent>

Parameters:

event - The value to coalesce with the pending data using the EventAggregator that was specified when this dispach source was created.

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class BaseSuspendable

fireEvent

private void fireEvent(MergedEvent event)

onStartup

protected void onStartup()

Overrides:

onStartup in class BaseSuspendable

cancel

public void cancel()

Description copied from interface: DispatchSource

Asynchronously cancel the dispatch source, preventing any further invocation of its event handler runnable.

Cancellation prevents any further invocation of the event handler runnable for the specified dispatch source, but does not interrupt an event handler runnable that is already in progress.

The cancellation handler is submitted to the source's target queue once the the source's event handler has finished, indicating it is now safe to close the source's handle.

Specified by:

cancel in interface DispatchSource

See Also:

DispatchSource.setCancelHandler(Runnable)

onResume

protected void onResume()

Overrides:

onResume in class BaseSuspendable

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface DispatchSource

Returns:

true if the dispatch source has been canceled.

See Also:

DispatchSource.cancel()

setCancelHandler

@Deprecated
public void setCancelHandler(java.lang.Runnable handler)

Deprecated.

Description copied from interface: DispatchSource

Sets the cancellation handler runnable for the given dispatch source.

The cancellation handler (if specified) will be submitted to the source's target queue in response to a call to DispatchSource.cancel() once the system has released all references to the source's underlying handle and the source's event handler runnable has returned.

Specified by:

setCancelHandler in interface DispatchSource

Parameters:

handler - The cancellation handler runnable to submit to the source's target queue.

setEventHandler

@Deprecated
public void setEventHandler(java.lang.Runnable handler)

Deprecated.

Description copied from interface: DispatchSource

Sets the event handler runnable of this dispatch source.

Specified by:

setEventHandler in interface DispatchSource

Parameters:

handler - The event handler runnable to submit to the source's target queue.

setCancelHandler

public void setCancelHandler(Task cancelHandler)

Description copied from interface: DispatchSource

Sets the cancellation handler task for the given dispatch source.

The cancellation handler (if specified) will be submitted to the source's target queue in response to a call to DispatchSource.cancel() once the system has released all references to the source's underlying handle and the source's event handler runnable has returned.

Specified by:

setCancelHandler in interface DispatchSource

Parameters:

cancelHandler - The cancellation handler runnable to submit to the source's target queue.

setEventHandler

public void setEventHandler(Task eventHandler)

Description copied from interface: DispatchSource

Sets the event handler task of this dispatch source.

Specified by:

setEventHandler in interface DispatchSource

Parameters:

eventHandler - The event handler runnable to submit to the source's target queue.

debug

protected void debug(java.lang.String str,
                     java.lang.Object... args)

debug

protected void debug(java.lang.Throwable thrown,
                     java.lang.String str,
                     java.lang.Object... args)