org.fusesource.hawtdispatch

Interface CustomDispatchSource<Event,MergedEvent>

Type Parameters:

Event -

MergedEvent -

All Superinterfaces:

DispatchObject, DispatchSource, Suspendable

All Known Implementing Classes:

HawtCustomDispatchSource

public interface CustomDispatchSource<Event,MergedEvent>
extends DispatchSource

A dispatch source that is used to coalesce multiple application generated events for later processing by the dispatch source event handler.

Method Summary

Modifier and Type	Method and Description
MergedEvent	getData() Returns pending data for the dispatch source.
void	merge(Event value) Merges data into a dispatch source and submits its event handler runnable to its target queue.

Methods inherited from interface org.fusesource.hawtdispatch.DispatchSource

cancel, isCanceled, setCancelHandler, setCancelHandler, setEventHandler, setEventHandler

Methods inherited from interface org.fusesource.hawtdispatch.DispatchObject

getTargetQueue, setTargetQueue

Methods inherited from interface org.fusesource.hawtdispatch.Suspendable

isSuspended, resume, suspend

Method Detail

getData

MergedEvent getData()

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.

merge

void merge(Event value)

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

Parameters:

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