SequenceReportingEventHandler (Disruptor Framework 4.0.0 API)

Type Parameters:

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

All Superinterfaces:

EventHandler<T>, EventHandlerIdentity
```
public interface SequenceReportingEventHandler<T>
extends EventHandler<T>
```
Used by the BatchEventProcessor to set a callback allowing the EventHandler to notify when it has finished consuming an event if this happens after the EventHandler.onEvent(Object, long, boolean) call.
Typically this would be used when the handler is performing some sort of batching operation such as writing to an IO device; after the operation has completed, the implementation should call Sequence.set(long) to update the sequence and allow other processes that are dependent on this handler to progress.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`onBatchStart(long batchSize, long queueDepth)`	Invoked by `BatchEventProcessor` prior to processing a batch of events
`default void`	`onShutdown()`	Called once just before the event processing thread is shutdown.
`default void`	`onStart()`	Called once on thread start before first event is available.
`default void`	`onTimeout(long sequence)`	Invoked when a `BatchEventProcessor`'s `WaitStrategy` throws a `TimeoutException`.
`void`	`setSequenceCallback(Sequence sequenceCallback)`	Call by the `BatchEventProcessor` to setup the callback.

Methods inherited from interface com.lmax.disruptor.EventHandler
onEvent

- Method Detail
  - setSequenceCallback
```
void setSequenceCallback(Sequence sequenceCallback)
```
    Call by the BatchEventProcessor to setup the callback.
    
    Specified by:
    
    setSequenceCallback in interface EventHandler<T>
    
    Parameters:
    
    sequenceCallback - callback on which to notify the BatchEventProcessor that the sequence has progressed.
  - onBatchStart
```
default void onBatchStart(long batchSize,
                          long queueDepth)
```
    Invoked by BatchEventProcessor prior to processing a batch of events
    
    Parameters:
    
    batchSize - the size of the batch that is starting
    
    queueDepth - the total number of queued up events including the batch about to be processed
  - onStart
```
default void onStart()
```
    Called once on thread start before first event is available.
  - onShutdown
```
default void onShutdown()
```
    Called once just before the event processing thread is shutdown.
    Sequence event processing will already have stopped before this method is called. No events will be processed after this message.
  - onTimeout
```
default void onTimeout(long sequence)
                throws java.lang.Exception
```
    Invoked when a BatchEventProcessor's WaitStrategy throws a TimeoutException.
    
    Parameters:
    
    sequence - - the last processed sequence.
    
    Throws:
    
    java.lang.Exception - if the implementation is unable to handle this timeout.