org.gradle.messaging.actor

Interface Actor

All Superinterfaces:

Dispatch<MethodInvocation>, Stoppable, StoppableDispatch<MethodInvocation>, ThreadSafe

public interface Actor
extends StoppableDispatch<MethodInvocation>, ThreadSafe

An Actor dispatches method calls to a target object in a thread-safe manner. Methods are called either by calling Dispatch.dispatch(Object) on the actor, or using the proxy object returned by getProxy(Class). Methods are delivered to the target object in the order they are called on the actor, but are delivered to the target object by a single thread at a time. In this way, the target object does not need to perform any synchronisation.

An actor uses one of two modes to deliver method calls to the target object:

• Non-blocking, or asynchronous, so that method dispatch does not block waiting for the method call to be delivered or executed. In this mode, the method return value or exception is not delivered back to the dispatcher.
• Blocking, or synchronous, so that method dispatch blocks until the method call has been delivered and executed. In this mode, the method return value or exception is delivered back to the dispatcher.

All implementations of this interface must be thread-safe.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	getProxy(Class<T> type) Creates a proxy which delivers method calls to the target object.
void	stop() Stops accepting new method calls, and blocks until all method calls have been executed by the target object.

Methods inherited from interface org.gradle.messaging.dispatch.Dispatch

dispatch

Method Detail

getProxy

<T> T getProxy(Class<T> type)

Creates a proxy which delivers method calls to the target object.

Parameters:

type - the type for the proxy.

Returns:

The proxy.

stop

void stop()
          throws DispatchException

Stops accepting new method calls, and blocks until all method calls have been executed by the target object.

Specified by:

stop in interface Stoppable

Specified by:

stop in interface StoppableDispatch<MethodInvocation>

Throws:

DispatchException - When there were any failures dispatching method calls to the target object.