org.gradle.launcher.daemon.server

Class Daemon

java.lang.Object

org.gradle.launcher.daemon.server.Daemon

All Implemented Interfaces:

Runnable, Stoppable

public class Daemon
extends Object
implements Runnable, Stoppable

A long-lived build server that accepts commands via a communication channel.

Daemon instances are single use and have a start/stop debug. They are also threadsafe.

See DaemonClient for a description of the daemon communication protocol.

Constructor Summary

Constructors

Constructor and Description
Daemon(DaemonServerConnector connector, DaemonRegistry daemonRegistry, DaemonContext daemonContext, String password, DaemonCommandExecuter commandExecuter, ExecutorFactory executorFactory) Creates a new daemon instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	awaitIdleTimeout(int idleTimeout) Waits for the daemon to be idle for the specified number of milliseconds.
void	awaitStop() Blocks until this daemon is stopped by something else (i.e.
boolean	awaitStopOrIdleTimeout(int idleTimeout) Waits until the daemon is either stopped, or has been idle for the given number of milliseconds.
Address	getAddress()
String	getUid()
void	run() Starts the daemon, blocking until it is stopped (either by Stop command or by another thread calling stop())
void	start() Starts the daemon, receiving connections asynchronously (i.e.
void	stop() Stops the daemon, blocking until any current requests/connections have been satisfied.

Methods inherited from class java.lang.Object

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

Constructor Detail

Daemon

public Daemon(DaemonServerConnector connector,
      DaemonRegistry daemonRegistry,
      DaemonContext daemonContext,
      String password,
      DaemonCommandExecuter commandExecuter,
      ExecutorFactory executorFactory)

Creates a new daemon instance.

Parameters:

connector - The provider of server connections for this daemon

daemonRegistry - The registry that this daemon should advertise itself in

Method Detail

getUid

public String getUid()

getAddress

public Address getAddress()

start

public void start()

Starts the daemon, receiving connections asynchronously (i.e. returns immediately).

Throws:

IllegalStateException - if this daemon is already running, or has already been stopped.

stop

public void stop()

Stops the daemon, blocking until any current requests/connections have been satisfied.

This is the semantically the same as sending the daemon the Stop command.

This method does not quite conform to the semantics of the Stoppable contract in that it will NOT wait for any executing builds to stop before returning. This is by design as we currently have no way of gracefully stopping a build process and blocking until it's done would not allow us to tear down the jvm like we need to. This may change in the future if we create a way to interrupt a build.

What will happen though is that the daemon will immediately disconnect from any clients and remove itself from the registry.

Specified by:

stop in interface Stoppable

awaitStop

public void awaitStop()

Blocks until this daemon is stopped by something else (i.e. does not ask it to stop)

awaitStopOrIdleTimeout

public boolean awaitStopOrIdleTimeout(int idleTimeout)

Waits until the daemon is either stopped, or has been idle for the given number of milliseconds.

Returns:

true if it was stopped, false if it hit the given idle timeout.

awaitIdleTimeout

public void awaitIdleTimeout(int idleTimeout)
                      throws DaemonStoppedException

Waits for the daemon to be idle for the specified number of milliseconds.

Throws:

DaemonStoppedException - if the daemon is explicitly stopped instead of idling out.

run

public void run()

Starts the daemon, blocking until it is stopped (either by Stop command or by another thread calling stop())

Specified by:

run in interface Runnable