org.gradle.messaging.dispatch

Class AsyncReceive<T>

java.lang.Object

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

All Implemented Interfaces:

Stoppable, AsyncStoppable

public class AsyncReceive<T>
extends Object
implements AsyncStoppable

Receives messages asynchronously. One or more Receive instances can use used as a source of messages. Messages are sent to a Dispatch

It is also possible to specify an onReceiversExhausted Runnable callback that will be run when all of the given receivers have been exhausted of messages. However, the current implementation is flawed in that this may erroneously fire if the first receiver is exhausted before the second starts.

Constructor Summary

Constructors

Constructor and Description
AsyncReceive(Executor executor)
AsyncReceive(Executor executor, Dispatch<? super T> dispatch)
AsyncReceive(Executor executor, Dispatch<? super T> dispatch, Runnable onReceiversExhausted)
AsyncReceive(Executor executor, Runnable onReceiversExhausted)

Method Summary

Methods

Modifier and Type	Method and Description
void	dispatchTo(Dispatch<? super T> dispatch) Starts dispatching to the given dispatch.
void	receiveFrom(Receive<? extends T> receive) Starts receiving from the given receive.
void	requestStop() Stops receiving new messages.
void	stop() Stops receiving new messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncReceive

public AsyncReceive(Executor executor)

AsyncReceive

public AsyncReceive(Executor executor,
            Runnable onReceiversExhausted)

AsyncReceive

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

AsyncReceive

public AsyncReceive(Executor executor,
            Dispatch<? super T> dispatch,
            Runnable onReceiversExhausted)

Method Detail

dispatchTo

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

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

receiveFrom

public void receiveFrom(Receive<? extends T> receive)

Starts receiving from the given receive. The receive does not need to be thread-safe.

requestStop

public void requestStop()

Stops receiving new messages.

Specified by:

requestStop in interface AsyncStoppable

stop

public void stop()

Stops receiving new messages. Blocks until all queued messages have been delivered.

Specified by:

stop in interface Stoppable