reactor.event.dispatch

Class RingBufferDispatcher

java.lang.Object

reactor.event.dispatch.AbstractLifecycleDispatcher

reactor.event.dispatch.AbstractSingleThreadDispatcher

reactor.event.dispatch.RingBufferDispatcher

All Implemented Interfaces:

java.util.concurrent.Executor, Dispatcher

Direct Known Subclasses:

EventLoopDispatcher

public class RingBufferDispatcher
extends AbstractSingleThreadDispatcher

Implementation of a Dispatcher that uses a RingBuffer to queue tasks to execute.

Nested Class Summary

Nested classes/interfaces inherited from class reactor.event.dispatch.AbstractSingleThreadDispatcher

AbstractSingleThreadDispatcher.SingleThreadTask

Nested classes/interfaces inherited from class reactor.event.dispatch.AbstractLifecycleDispatcher

AbstractLifecycleDispatcher.Task

Constructor Summary

Constructors

Constructor and Description
RingBufferDispatcher(java.lang.String name) Creates a new RingBufferDispatcher with the given name.
RingBufferDispatcher(java.lang.String name, int bufferSize, Consumer<java.lang.Throwable> uncaughtExceptionHandler, com.lmax.disruptor.dsl.ProducerType producerType, com.lmax.disruptor.WaitStrategy waitStrategy) Creates a new RingBufferDispatcher with the given name.

Method Summary

Modifier and Type	Method and Description
protected AbstractLifecycleDispatcher.Task	allocateTask()
boolean	awaitAndShutdown(long timeout, java.util.concurrent.TimeUnit timeUnit) Block until all submitted tasks have completed, then do a normal Dispatcher.shutdown().
protected void	execute(AbstractLifecycleDispatcher.Task task)
void	halt() Shutdown this Dispatcher, forcibly halting any tasks currently executing and discarding any tasks that have not yet been exected.
void	shutdown() Shutdown this Dispatcher such that it can no longer be used.

Methods inherited from class reactor.event.dispatch.AbstractSingleThreadDispatcher

allocateRecursiveTask, expandTailRecursionPile, getBacklog

Methods inherited from class reactor.event.dispatch.AbstractLifecycleDispatcher

addToTailRecursionPile, alive, awaitAndShutdown, dispatch, dispatch, execute, getContext, isInContext, route

Methods inherited from class java.lang.Object

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

Constructor Detail

RingBufferDispatcher

public RingBufferDispatcher(java.lang.String name)

Creates a new RingBufferDispatcher with the given name. It will use a RingBuffer with 1024 slots, configured with a producer type of MULTI and a blocking wait strategy.

Parameters:

name - The name of the dispatcher.

RingBufferDispatcher

public RingBufferDispatcher(java.lang.String name,
                            int bufferSize,
                            Consumer<java.lang.Throwable> uncaughtExceptionHandler,
                            com.lmax.disruptor.dsl.ProducerType producerType,
                            com.lmax.disruptor.WaitStrategy waitStrategy)

Creates a new RingBufferDispatcher with the given name. It will use a RingBuffer with bufferSize slots, configured with the given producerType and waitStrategy.

Parameters:

name - The name of the dispatcher

bufferSize - The size to configure the ring buffer with

producerType - The producer type to configure the ring buffer with

waitStrategy - The wait strategy to configure the ring buffer with

Method Detail

awaitAndShutdown

public boolean awaitAndShutdown(long timeout,
                                java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: Dispatcher

Block until all submitted tasks have completed, then do a normal Dispatcher.shutdown().

shutdown

public void shutdown()

Description copied from interface: Dispatcher

Shutdown this Dispatcher such that it can no longer be used.

Specified by:

shutdown in interface Dispatcher

Overrides:

shutdown in class AbstractLifecycleDispatcher

halt

public void halt()

Description copied from interface: Dispatcher

Shutdown this Dispatcher, forcibly halting any tasks currently executing and discarding any tasks that have not yet been exected.

Specified by:

halt in interface Dispatcher

Overrides:

halt in class AbstractLifecycleDispatcher

allocateTask

protected AbstractLifecycleDispatcher.Task allocateTask()

Specified by:

allocateTask in class AbstractSingleThreadDispatcher

execute

protected void execute(AbstractLifecycleDispatcher.Task task)

Specified by:

execute in class AbstractLifecycleDispatcher