org.neo4j.concurrent

Class AsyncEvents<T extends AsyncEvent>

java.lang.Object

org.neo4j.concurrent.AsyncEvents<T>

Type Parameters:

T - The type of events the AsyncEvents will process.

All Implemented Interfaces:

Runnable, AsyncEventSender<T>

public class AsyncEvents<T extends AsyncEvent>
extends Object
implements AsyncEventSender<T>, Runnable

AsyncEvents is a mechanism for queueing up events to be processed asynchronously in a background thread. The AsyncEvents object implements Runnable, so it can be passed to a thread pool, or given to a dedicated thread. The runnable will then occupy a thread and dedicate it to background processing of events, until the AsyncEvents is shutdown(). If events are sent to an AsyncEvents that has been shut down, then those events will be processed in the foreground as a fall-back. Note, however, that no events are processed until the background thread is started. The AsyncEvents is given a Consumer of the specified event type upon construction, and will use it for doing the actual processing of events once they have been collected.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AsyncEvents.Monitor

Constructor Summary

Constructors

Constructor and Description
AsyncEvents(Consumer<T> eventConsumer, AsyncEvents.Monitor monitor) Construct a new AsyncEvents instance, that will use the given consumer to process the events.

Method Summary

Modifier and Type	Method and Description
void	awaitStartup()
void	awaitTermination()
void	run()
void	send(T event) Send the given event to a background thread for processing.
void	shutdown() Initiate the shut down process of this AsyncEvents instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncEvents

public AsyncEvents(Consumer<T> eventConsumer,
                   AsyncEvents.Monitor monitor)

Construct a new AsyncEvents instance, that will use the given consumer to process the events.

Parameters:

eventConsumer - The Consumer used for processing the events that are sent in.

Method Detail

send

public void send(T event)

Description copied from interface: AsyncEventSender

Send the given event to a background thread for processing.

Specified by:

send in interface AsyncEventSender<T extends AsyncEvent>

Parameters:

event - The event that needs to be processed in the background.

run

public void run()

Specified by:

run in interface Runnable

shutdown

public void shutdown()

Initiate the shut down process of this AsyncEvents instance. This call does not block or otherwise wait for the background thread to terminate.

awaitStartup

public void awaitStartup()

awaitTermination

public void awaitTermination()
                      throws InterruptedException

Throws:

InterruptedException