org.gradle.launcher.daemon.client

Class DaemonClient

java.lang.Object

org.gradle.launcher.daemon.client.DaemonClient

All Implemented Interfaces:

GradleLauncherActionExecuter<BuildActionParameters>

Direct Known Subclasses:

SingleUseDaemonClient

public class DaemonClient
extends Object
implements GradleLauncherActionExecuter<BuildActionParameters>

The client piece of the build daemon.

Immediately upon forming a connection, the daemon may send OutputEvent messages back to the client and may do so for as long as the connection is open.

The client is expected to send exactly one Build message as the first message it sends to the daemon. The daemon may either return DaemonBusy or BuildStarted. If the former is received, the client should not send any more messages to this daemon. If the latter is received, the client can assume the daemon is performing the build. The client may then send zero to many ForwardInput messages. If the client's stdin stream is closed before the connection to the daemon is terminated, the client must send a CloseInput command to instruct the daemon that no more input is to be expected.

After receiving the Result message (after a BuildStarted mesage), the client must send a CloseInput command if it has not already done so due to the stdin stream being closed. At this point the client is expected to terminate the connection with the daemon.

If the daemon returns a null message before returning a Result object, it has terminated unexpectedly for some reason.

Field Summary

Fields

Modifier and Type	Field and Description
protected BuildClientMetaData	clientMetaData
protected DaemonConnector	connector

Constructor Summary

Constructors

Constructor and Description
DaemonClient(DaemonConnector connector, BuildClientMetaData clientMetaData, OutputEventListener outputEventListener, Spec<DaemonContext> compatibilitySpec, InputStream buildStandardInput)

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	execute(GradleLauncherAction<T> action, BuildActionParameters parameters) Executes the given action in the daemon.
protected Object	executeBuild(Build build, Connection<Object> connection)
void	stop() Stops all daemons, if any is running.

Methods inherited from class java.lang.Object

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

Field Detail

connector

protected final DaemonConnector connector

clientMetaData

protected final BuildClientMetaData clientMetaData

Constructor Detail

DaemonClient

public DaemonClient(DaemonConnector connector,
            BuildClientMetaData clientMetaData,
            OutputEventListener outputEventListener,
            Spec<DaemonContext> compatibilitySpec,
            InputStream buildStandardInput)

Method Detail

stop

public void stop()

Stops all daemons, if any is running.

execute

public <T> T execute(GradleLauncherAction<T> action,
            BuildActionParameters parameters)

Executes the given action in the daemon. The action and parameters must be serializable.

Specified by:

execute in interface GradleLauncherActionExecuter<BuildActionParameters>

Type Parameters:

T - The result type

Parameters:

action - The action

Returns:

The result.

Throws:

ReportedException - On failure, when the failure has already been logged/reported.

executeBuild

protected Object executeBuild(Build build,
                  Connection<Object> connection)
                       throws org.gradle.launcher.daemon.client.DaemonInitialConnectException

Throws:

org.gradle.launcher.daemon.client.DaemonInitialConnectException