org.gradle.messaging.concurrent

Interface AsyncStoppable

All Superinterfaces:

Stoppable

All Known Subinterfaces:

Connection<T>, DisconnectAwareConnection<T>, MultiChannelConnection<T>, ObjectConnection, StoppableExecutor

All Known Implementing Classes:

AsyncDispatch, AsyncReceive, DefaultObjectConnection, DelegatingConnection, DisconnectAwareConnectionDecorator, EagerReceiveBuffer, MessageHub, MulticastConnection, ProtocolStack, SocketConnection, SynchronizedDispatch, TcpIncomingConnector

public interface AsyncStoppable
extends Stoppable

A Stoppable object whose stop process can be performed asynchronously.

Method Summary

Methods

Modifier and Type	Method and Description
void	requestStop() Requests that this stoppable commence a graceful stop.

Methods inherited from interface org.gradle.internal.Stoppable

stop

Method Detail

requestStop

void requestStop()

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.