org.gradle.foundation.ipc.gradle

Class GradleClient

java.lang.Object

org.gradle.foundation.ipc.gradle.GradleClient

public class GradleClient
extends Object

This is used to send information from a one process to another process. This one is used by the launched process where the server (the process that launched us) is listening for our messages over a socket connection. The server typically sets the port to listen to via java system properties.

To use this, instantiate it, then call start passing in a protocol (which defines the actual communication messages).

Constructor Summary

Constructors

Constructor and Description
GradleClient()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	sendMessage(String messageType, String message)
boolean	sendMessage(String messageType, String message, Serializable data) Call this to send a message and wait for the server to acknowledge siad message.
boolean	start(ClientProcess.Protocol protocol) Call this to start the client.
boolean	start(ClientProcess.Protocol protocol, int port) Call this to start the client.
void	stop() Call this to stop communications with the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

GradleClient

public GradleClient()

Method Detail

start

public boolean start(ClientProcess.Protocol protocol)

Call this to start the client. This version gets the port number as a system property. It does nothing if this property isn't defined.

Parameters:

protocol - the protocol to use to communicate with the server.

Returns:

true if successful, false if not.

start

public boolean start(ClientProcess.Protocol protocol,
            int port)

Call this to start the client.

Parameters:

protocol - the protocol to use to communicate with the server.

port - the port the server is listening on

Returns:

true if successful, false if not.

sendMessage

public boolean sendMessage(String messageType,
                  String message,
                  Serializable data)

Call this to send a message and wait for the server to acknowledge siad message.

sendMessage

public boolean sendMessage(String messageType,
                  String message)

stop

public void stop()

Call this to stop communications with the server.