org.gradle.launcher.daemon.server

Class DaemonStateCoordinator

java.lang.Object

org.gradle.launcher.daemon.server.DaemonStateCoordinator

All Implemented Interfaces:

Stoppable

public class DaemonStateCoordinator
extends Object
implements Stoppable

A tool for synchronising the state amongst different threads. This class has no knowledge of the Daemon's internals and is designed to be used internally by the daemon to coordinate itself and allow worker threads to control the daemon's busy/idle status. This is not exposed to clients of the daemon.

Constructor Summary

Constructors

Constructor and Description
DaemonStateCoordinator(Runnable onStart, Runnable onStartCommand, Runnable onFinishCommand, Runnable onStop, Runnable onStopRequested)

Method Summary

Methods

Modifier and Type	Method and Description
void	awaitIdleTimeout(int timeout)
void	awaitStop() Waits until stopped.
boolean	awaitStopOrIdleTimeout(int timeout) Waits until stopped, or timeout.
DaemonCommandExecution	getCurrentCommandExecution() The current command execution, or null if the daemon is idle.
double	getIdleMinutes()
boolean	hasBeenIdleFor(int milliseconds)
boolean	isBusy()
boolean	isIdle()
boolean	isRunning()
boolean	isStarted() Has the daemon started accepting connections.
boolean	isStopped()
boolean	isStoppingOrStopped()
DaemonCommandExecution	onFinishCommand() Called when the execution of a command is complete (or at least the daemon is available for new commands).
DaemonCommandExecution	onStartCommand(DaemonCommandExecution execution) Called when the execution of a command begins.
boolean	requestStop()
void	start() Called once when the daemon is up and ready for connections.
void	stop() Forcibly stops the daemon, even if it is busy.
void	stopAsSoonAsIdle() Perform a stop, but wait until the daemon is idle to cut any open connections.

Methods inherited from class java.lang.Object

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

Constructor Detail

DaemonStateCoordinator

public DaemonStateCoordinator(Runnable onStart,
                      Runnable onStartCommand,
                      Runnable onFinishCommand,
                      Runnable onStop,
                      Runnable onStopRequested)

Method Detail

awaitStop

public void awaitStop()

Waits until stopped.

start

public void start()

Called once when the daemon is up and ready for connections.

awaitStopOrIdleTimeout

public boolean awaitStopOrIdleTimeout(int timeout)

Waits until stopped, or timeout.

Returns:

true if stopped, false if timeout

awaitIdleTimeout

public void awaitIdleTimeout(int timeout)
                      throws DaemonStoppedException

Throws:

DaemonStoppedException

stopAsSoonAsIdle

public void stopAsSoonAsIdle()

Perform a stop, but wait until the daemon is idle to cut any open connections. The daemon will be removed from the registry upon calling this regardless of whether it is busy or not. If it is idle, this method will block until the daemon fully stops. If the daemon is busy, this method will return after removing the daemon from the registry but before the daemon is fully stopped. In this case, the daemon will stop as soon as onFinishCommand() is called.

stop

public void stop()

Forcibly stops the daemon, even if it is busy. If the daemon is busy and the client is waiting for a response, it may receive ?null? from the daemon as the connection may be closed by this method before the result is sent back.

Specified by:

stop in interface Stoppable

See Also:

stopAsSoonAsIdle()

requestStop

public boolean requestStop()

Returns:

returns false if the daemon was already requested to stop

onStartCommand

public DaemonCommandExecution onStartCommand(DaemonCommandExecution execution)

Called when the execution of a command begins.

If the daemon is busy (i.e. already executing a command), this method will return the existing execution which the caller should be prepared for without considering the given execution to be in progress. If the daemon is idle the return value will be null and the given execution will be considered in progress.

onFinishCommand

public DaemonCommandExecution onFinishCommand()

Called when the execution of a command is complete (or at least the daemon is available for new commands).

If the daemon is currently idle, this method will return null. If it is busy, it will return what was the current execution which will considered to be complete (putting the daemon back in idle state).

If stopAsSoonAsIdle() was previously called, this method will block while the daemon stops

getCurrentCommandExecution

public DaemonCommandExecution getCurrentCommandExecution()

The current command execution, or null if the daemon is idle.

isStarted

public boolean isStarted()

Has the daemon started accepting connections.

getIdleMinutes

public double getIdleMinutes()

hasBeenIdleFor

public boolean hasBeenIdleFor(int milliseconds)

isStopped

public boolean isStopped()

isStoppingOrStopped

public boolean isStoppingOrStopped()

isIdle

public boolean isIdle()

isBusy

public boolean isBusy()

isRunning

public boolean isRunning()