org.gradle.messaging.remote.internal

Class DisconnectAwareConnectionDecorator<T>

java.lang.Object

org.gradle.messaging.remote.internal.DelegatingConnection<T>

org.gradle.messaging.remote.internal.DisconnectAwareConnectionDecorator<T>

All Implemented Interfaces:

Stoppable, AsyncStoppable, Dispatch<T>, Receive<T>, Connection<T>, DisconnectAwareConnection<T>

public class DisconnectAwareConnectionDecorator<T>
extends DelegatingConnection<T>
implements DisconnectAwareConnection<T>

A DisconnectAwareConnection implementation that decorates an existing connection, adding disconnect awareness.

This implementation uses EagerReceiveBuffer internally to receive messages as fast as they are sent. The messages are then collected by receive() as per normal.

NOTE: due to the use of a bounded buffer, disconnection may not be detected immediately if the internal buffer is full.

Constructor Summary

Constructors

Constructor and Description
DisconnectAwareConnectionDecorator(Connection<T> connection, StoppableExecutor executor)
DisconnectAwareConnectionDecorator(Connection<T> connection, StoppableExecutor executor, int bufferSize)

Method Summary

Methods

Modifier and Type	Method and Description
Runnable	onDisconnect(Runnable disconnectAction) Used to specify the action to take when a disconnection is detected.
T	receive() Blocks until the next message is available.
void	requestStop() Requests that this stoppable commence a graceful stop.
void	stop() Requests a graceful stop of this object.

Methods inherited from class org.gradle.messaging.remote.internal.DelegatingConnection

dispatch, toString

Methods inherited from class java.lang.Object

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

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

dispatch

Constructor Detail

DisconnectAwareConnectionDecorator

public DisconnectAwareConnectionDecorator(Connection<T> connection,
                                  StoppableExecutor executor)

DisconnectAwareConnectionDecorator

public DisconnectAwareConnectionDecorator(Connection<T> connection,
                                  StoppableExecutor executor,
                                  int bufferSize)

Method Detail

onDisconnect

public Runnable onDisconnect(Runnable disconnectAction)

Description copied from interface: DisconnectAwareConnection

Used to specify the action to take when a disconnection is detected.

It is guaranteed that calling receive() on this connection will forever return null after the disconnect action has been started.

If this connection has an associates disconnect action at the time a disconnection is detected, it is guaranteed to be invoked before any call to receive() will return null.

If the stop() method is called on this connection before a disconnection is detected, the disconnect action will never be called.

Specified by:

onDisconnect in interface DisconnectAwareConnection<T>

Parameters:

disconnectAction - The action to perform on disconnection, or null to remove any existing action.

Returns:

The previous disconnect action, or null if no action had been previously registered.

receive

public T receive()

Description copied from interface: Receive

Blocks until the next message is available. Returns null when the end of the message stream has been reached.

Specified by:

receive in interface Receive<T>

Overrides:

receive in class DelegatingConnection<T>

Returns:

The next message, or null when the end of the stream has been reached.

requestStop

public void requestStop()

Description copied from interface: AsyncStoppable

Requests that this stoppable commence a graceful stop. Does not block. You should call Stoppable.stop() to wait for the stop process to complete.

Generally, an AsyncStoppable should continue to complete existing work after this method has returned. It should, however, stop accepting new work.

Requesting stopping does not guarantee the stoppable actually stops. Requesting stopping means preparing for stopping; stopping accepting new work. You have to call stop at some point anyway if your intention is to completely stop the stoppable.

Specified by:

requestStop in interface AsyncStoppable

Overrides:

requestStop in class DelegatingConnection<T>

stop

public void stop()

Description copied from interface: Stoppable

Requests a graceful stop of this object. Blocks until all concurrent activity has been completed.

If this object has already been stopped, this method does nothing.

Specified by:

stop in interface Stoppable

Overrides:

stop in class DelegatingConnection<T>