Module com.lmax.disruptor

Package com.lmax.disruptor

Class BatchEventProcessor<T>

java.lang.Object

com.lmax.disruptor.BatchEventProcessor<T>

Type Parameters:

T - event implementation storing the data for sharing during exchange or parallel coordination of an event.

All Implemented Interfaces:

EventProcessor, java.lang.Runnable

public final class BatchEventProcessor<T>
extends java.lang.Object
implements EventProcessor

Convenience class for handling the batching semantics of consuming entries from a RingBuffer and delegating the available events to an EventHandler.

Constructor Summary

Constructors

Constructor	Description
BatchEventProcessor(DataProvider<T> dataProvider, SequenceBarrier sequenceBarrier, EventHandler<? super T> eventHandler)	Construct a EventProcessor that will automatically track the progress by updating its sequence when the EventHandler.onEvent(Object, long, boolean) method returns.

Method Summary

Modifier and Type	Method	Description
Sequence	getSequence()	Get a reference to the Sequence being used by this EventProcessor.
void	halt()	Signal that this EventProcessor should stop when it has finished consuming at the next clean break.
boolean	isRunning()
void	run()	It is ok to have another thread rerun this method after a halt().
void	setExceptionHandler(ExceptionHandler<? super T> exceptionHandler)	Set a new ExceptionHandler for handling exceptions propagated out of the BatchEventProcessor.
void	setRewindStrategy(BatchRewindStrategy batchRewindStrategy)	Set a new BatchRewindStrategy for customizing how to handle a RewindableException Which can include whether the batch should be rewound and reattempted, or simply thrown and move on to the next sequence the default is a SimpleBatchRewindStrategy which always rewinds

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchEventProcessor

public BatchEventProcessor(DataProvider<T> dataProvider,
                           SequenceBarrier sequenceBarrier,
                           EventHandler<? super T> eventHandler)

Construct a EventProcessor that will automatically track the progress by updating its sequence when the EventHandler.onEvent(Object, long, boolean) method returns.

Parameters:

dataProvider - to which events are published.

sequenceBarrier - on which it is waiting.

eventHandler - is the delegate to which events are dispatched.

Method Detail

getSequence

public Sequence getSequence()

Description copied from interface: EventProcessor

Get a reference to the Sequence being used by this EventProcessor.

Specified by:

getSequence in interface EventProcessor

Returns:

reference to the Sequence for this EventProcessor

halt

public void halt()

Description copied from interface: EventProcessor

Signal that this EventProcessor should stop when it has finished consuming at the next clean break. It will call SequenceBarrier.alert() to notify the thread to check status.

Specified by:

halt in interface EventProcessor

isRunning

public boolean isRunning()

Specified by:

isRunning in interface EventProcessor

Returns:

whether this event processor is running or not Implementations should ideally return false only when the associated thread is idle.

setExceptionHandler

public void setExceptionHandler(ExceptionHandler<? super T> exceptionHandler)

Set a new ExceptionHandler for handling exceptions propagated out of the BatchEventProcessor.

Parameters:

exceptionHandler - to replace the existing exceptionHandler.

setRewindStrategy

public void setRewindStrategy(BatchRewindStrategy batchRewindStrategy)

Set a new BatchRewindStrategy for customizing how to handle a RewindableException Which can include whether the batch should be rewound and reattempted, or simply thrown and move on to the next sequence the default is a SimpleBatchRewindStrategy which always rewinds

Parameters:

batchRewindStrategy - to replace the existing rewindStrategy.

run

public void run()

It is ok to have another thread rerun this method after a halt().

Specified by:

run in interface java.lang.Runnable

Throws:

java.lang.IllegalStateException - if this object instance is already running in a thread