reactor.event.dispatch

Class ActorDispatcher

java.lang.Object

reactor.event.dispatch.ActorDispatcher

All Implemented Interfaces:

java.util.concurrent.Executor, Dispatcher

public final class ActorDispatcher
extends java.lang.Object
implements Dispatcher

An implementation of Dispatcher that maps a key to a delegate dispatcher and caches the mapping within its internal Registry. Thus making similar key-based dispatching reusing the same dispatcher, a pattern also dubbed as "Actor".

Constructor Summary

Constructors

Constructor and Description
ActorDispatcher(Function<java.lang.Object,Dispatcher> delegate)

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 Dispatcher.shutdown().
boolean	awaitAndShutdown(long timeout, java.util.concurrent.TimeUnit timeUnit) Block until all submitted tasks have completed, then do a normal Dispatcher.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	execute(java.lang.Runnable command)
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 java.lang.Object

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

Constructor Detail

ActorDispatcher

public ActorDispatcher(Function<java.lang.Object,Dispatcher> delegate)

Method Detail

alive

public boolean alive()

Description copied from interface: Dispatcher

Determine whether this Dispatcher can be used for dispatching.

Specified by:

alive in interface Dispatcher

Returns:

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

awaitAndShutdown

public boolean awaitAndShutdown()

Description copied from interface: Dispatcher

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

Specified by:

awaitAndShutdown in interface Dispatcher

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().

Specified by:

awaitAndShutdown in interface Dispatcher

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

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

dispatch

public <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)

Description copied from interface: Dispatcher

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.

Specified by:

dispatch in interface Dispatcher

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

dispatch

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

Description copied from interface: Dispatcher

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.

Specified by:

dispatch in interface Dispatcher

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)

execute

public void execute(java.lang.Runnable command)

Specified by:

execute in interface java.util.concurrent.Executor