org.gradle.messaging.remote.internal

Class DelegatingConnection<T>

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DisconnectAwareConnectionDecorator

public class DelegatingConnection<T>
extends Object
implements Connection<T>

Constructor Summary

Constructors

Constructor and Description
DelegatingConnection(Connection<T> delegate)

Method Summary

Methods

Modifier and Type	Method and Description
void	dispatch(T message) Dispatches the next message.
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingConnection

public DelegatingConnection(Connection<T> delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

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>

Returns:

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

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()

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

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