Package com.lmax.disruptor
Class AggregateEventHandler<T>
java.lang.Object
com.lmax.disruptor.AggregateEventHandler<T>
- Type Parameters:
T
- event implementation storing the data for sharing during exchange or parallel coordination of an event.
- All Implemented Interfaces:
EventHandler<T>
,LifecycleAware
public final class AggregateEventHandler<T>
extends Object
implements EventHandler<T>, LifecycleAware
An aggregate collection of
EventHandler
s that get called in sequence for each event.-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionAggregateEventHandler
(EventHandler<T>... eventHandlers) Construct an aggregate collection ofEventHandler
s to be called in sequence. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Called when a publisher has published an event to theRingBuffer
.void
Called once just before the thread is shutdown.void
onStart()
Called once on thread start before first event is available.
-
Field Details
-
eventHandlers
-
-
Constructor Details
-
AggregateEventHandler
Construct an aggregate collection ofEventHandler
s to be called in sequence.- Parameters:
eventHandlers
- to be called in sequence.
-
-
Method Details
-
onEvent
Description copied from interface:EventHandler
Called when a publisher has published an event to theRingBuffer
. TheBatchEventProcessor
will read messages from theRingBuffer
in batches, where a batch is all of the events available to be processed without having to wait for any new event to arrive. This can be useful for event handlers that need to do slower operations like I/O as they can group together the data from multiple events into a single operation. Implementations should ensure that the operation is always performed when endOfBatch is true as the time between that message an the next one is inderminate.- Specified by:
onEvent
in interfaceEventHandler<T>
- Parameters:
event
- published to theRingBuffer
sequence
- of the event being processedendOfBatch
- flag to indicate if this is the last event in a batch from theRingBuffer
- Throws:
Exception
- if the EventHandler would like the exception handled further up the chain.
-
onStart
public void onStart()Description copied from interface:LifecycleAware
Called once on thread start before first event is available.- Specified by:
onStart
in interfaceLifecycleAware
-
onShutdown
public void onShutdown()Description copied from interface:LifecycleAware
Called once just before the thread is shutdown.
Sequence event processing will already have stopped before this method is called. No events will be processed after this message.
- Specified by:
onShutdown
in interfaceLifecycleAware
-