org.gradle.messaging.dispatch

Class AsyncDispatch<T>

java.lang.Object

org.gradle.messaging.dispatch.AsyncDispatch<T>

All Implemented Interfaces:

Stoppable, AsyncStoppable, Dispatch<T>, StoppableDispatch<T>

public class AsyncDispatch<T>
extends Object
implements StoppableDispatch<T>, AsyncStoppable

A Dispatch implementation which delivers messages asynchronously. Calls to dispatch(T) queue the message. Worker threads deliver the messages in the order they have been received to one of a pool of delegate Dispatch instances.

Constructor Summary

Constructors

Constructor and Description
AsyncDispatch(Executor executor)
AsyncDispatch(Executor executor, Dispatch<? super T> dispatch)
AsyncDispatch(Executor executor, Dispatch<? super T> dispatch, int maxQueueSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	dispatch(T message) Dispatches the next message.
void	dispatchTo(Dispatch<? super T> dispatch) Starts dispatching messages to the given handler.
void	requestStop() Commences a shutdown of this dispatch.
void	stop() Stops accepting new messages, and blocks until all queued messages have been dispatched.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncDispatch

public AsyncDispatch(Executor executor)

AsyncDispatch

public AsyncDispatch(Executor executor,
             Dispatch<? super T> dispatch)

AsyncDispatch

public AsyncDispatch(Executor executor,
             Dispatch<? super T> dispatch,
             int maxQueueSize)

Method Detail

dispatchTo

public void dispatchTo(Dispatch<? super T> dispatch)

Starts dispatching messages to the given handler. The handler does not need to be thread-safe.

dispatch

public void dispatch(T message)

Description copied from interface: Dispatch

Dispatches the next message. Blocks until the messages has been accepted but generally does not wait for the message to be processed. Delivery guarantees are implementation specific.

Specified by:

dispatch in interface Dispatch<T>

Parameters:

message - The message.

requestStop

public void requestStop()

Commences a shutdown of this dispatch.

Specified by:

requestStop in interface AsyncStoppable

stop

public void stop()

Stops accepting new messages, and blocks until all queued messages have been dispatched.

Specified by:

stop in interface Stoppable

Specified by:

stop in interface StoppableDispatch<T>