reactor.event.dispatch

Interface Dispatcher

All Superinterfaces:

java.util.concurrent.Executor

All Known Implementing Classes:

AbstractLifecycleDispatcher, AbstractMultiThreadDispatcher, AbstractSingleThreadDispatcher, ActorDispatcher, EventLoopDispatcher, RingBufferDispatcher, SynchronousDispatcher, ThreadPoolExecutorDispatcher, TraceableDelegatingDispatcher, WorkQueueDispatcher

public interface Dispatcher
extends java.util.concurrent.Executor

A Dispatcher is used to dispatch Events to Consumers. The details of how the dispatching is performed, for example on the same thread or using a different thread, are determined by the implementation.

Method Summary

Modifier and Type	Method and Description
boolean	alive() Determine whether this Dispatcher can be used for dispatching.
boolean	awaitAndShutdown() Block until all submitted tasks have completed, then do a normal shutdown().
boolean	awaitAndShutdown(long timeout, java.util.concurrent.TimeUnit timeUnit) Block until all submitted tasks have completed, then do a normal shutdown().
<E extends Event<?>> void	dispatch(E event, EventRouter eventRouter, Consumer<E> consumer, Consumer<java.lang.Throwable> errorConsumer) Instruct the Dispatcher to dispatch the given Event using the given Consumer.
<E extends Event<?>> void	dispatch(java.lang.Object key, E event, Registry<Consumer<? extends Event<?>>> consumerRegistry, Consumer<java.lang.Throwable> errorConsumer, EventRouter eventRouter, Consumer<E> completionConsumer) Instruct the Dispatcher to dispatch the event that has the given key.
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 interface java.util.concurrent.Executor

execute

Method Detail

alive

boolean alive()

Determine whether this Dispatcher can be used for dispatching.

Returns:

true if this Dispatcher is alive and can be used, false otherwise.

awaitAndShutdown

boolean awaitAndShutdown()

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

awaitAndShutdown

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

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

shutdown

void shutdown()

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

halt

void halt()

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

dispatch

<E extends Event<?>> void dispatch(java.lang.Object key,
                                   E event,
                                   Registry<Consumer<? extends Event<?>>> consumerRegistry,
                                   Consumer<java.lang.Throwable> errorConsumer,
                                   EventRouter eventRouter,
                                   Consumer<E> completionConsumer)

Instruct the Dispatcher to dispatch the event that has the given key. The Consumers that will receive the event are selected from the consumerRegistry, and the event is routed to them using the eventRouter. In the event of an error during dispatching, the errorConsumer will be called. In the event of successful dispatching, the completionConsumer will be called.

Type Parameters:

E - type of the event

Parameters:

key - The key associated with the event

event - The event

consumerRegistry - The registry from which consumer's are selected

errorConsumer - The consumer that is invoked if dispatch fails. May be null

eventRouter - Used to route the event to the selected consumers

completionConsumer - The consumer that is driven if dispatch succeeds May be null

Throws:

java.lang.IllegalStateException - If the Dispatcher is not alive

dispatch

<E extends Event<?>> void dispatch(E event,
                                   EventRouter eventRouter,
                                   Consumer<E> consumer,
                                   Consumer<java.lang.Throwable> errorConsumer)

Instruct the Dispatcher to dispatch the given Event using the given Consumer. This optimized route bypasses all selection and routing so provides a significant throughput boost. If an error occurs, the given errorConsumer will be invoked.

Type Parameters:

E - type of the event

Parameters:

event - the event

eventRouter - invokes the Consumer in the correct thread

errorConsumer - consumer to invoke if dispatch fails (may be null)

Throws:

java.lang.IllegalStateException - If the Dispatcher is not alive