org.gradle.messaging.remote

Interface ObjectConnection

All Superinterfaces:

Addressable, AsyncStoppable, Stoppable

All Known Implementing Classes:

DefaultObjectConnection

public interface ObjectConnection
extends Addressable, AsyncStoppable

Manages a set of incoming and outgoing channels between 2 peers. Implementations must be thread-safe.

Method Summary

Methods

Modifier and Type	Method and Description
void	addIncoming(Class<?> type, Dispatch<? super MethodInvocation> dispatch) Registers a handler for incoming messages on the given type.
<T> void	addIncoming(Class<T> type, T instance) Registers a handler for incoming messages on the given type.
<T> T	addOutgoing(Class<T> type) Creates a transmitter for outgoing messages on the given type.
void	requestStop() Commences a graceful stop of this connection.
void	stop() Performs a graceful stop of this connection.

Methods inherited from interface org.gradle.messaging.remote.Addressable

getLocalAddress, getRemoteAddress

Method Detail

addOutgoing

<T> T addOutgoing(Class<T> type)

Creates a transmitter for outgoing messages on the given type. The returned object is thread-safe.

Parameters:

type - The type

Returns:

A sink. Method calls made on this object are sent as outgoing messages.

addIncoming

<T> void addIncoming(Class<T> type,
                   T instance)

Registers a handler for incoming messages on the given type. The provided handler is not required to be thread-safe. Messages are delivered to the handler by a single thread.

Parameters:

type - The type.

instance - The handler instance. Incoming messages on the given type are delivered to this handler.

addIncoming

void addIncoming(Class<?> type,
               Dispatch<? super MethodInvocation> dispatch)

Registers a handler for incoming messages on the given type. The provided handler is not required to be thread-safe. Messages are delivered to the handler by a single thread.

Parameters:

type - The type.

dispatch - The handler instance. Incoming messages on the given type are delivered to this handler.

requestStop

void requestStop()

Commences a graceful stop of this connection. Stops accepting outgoing messages. Requests that the peer stop sending incoming messages.

Specified by:

requestStop in interface AsyncStoppable

stop

void stop()

Performs a graceful stop of this connection. Stops accepting outgoing message. Blocks until all incoming messages have been handled, and all outgoing messages have been handled by the peer.

Specified by:

stop in interface Stoppable