org.gradle.foundation.ipc.basic

Class ClientProcess

java.lang.Object

org.gradle.foundation.ipc.basic.ClientProcess

public class ClientProcess
extends Object

The client of what the ProcessLauncherServer launches. The client makes a connection to the server and sends messages to it. The server responds to those messages, but does not initiate communications otherwise. You implement the Protocol interface to handle the specifics of the communications.

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClientProcess.Protocol Implement this to define the behavior of the communication on the client side.

Constructor Summary

Constructors

Constructor and Description
ClientProcess(ClientProcess.Protocol protocol)

Method Summary

Methods

Modifier and Type	Method and Description
MessageObject	readMessage() Call this to listen for a message from the server.
boolean	sendMessage(String messageType, String message)
boolean	sendMessage(String messageType, String message, Serializable data) Call this to send a message with some binary data.
MessageObject	sendMessageWaitForReply(String messageType, String message, Serializable data) Call this to send a message with some binary data and wait for the server's acknowledgement.
boolean	start(int port) Call this to attempt to connect to the server.
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

ClientProcess

public ClientProcess(ClientProcess.Protocol protocol)

Method Detail

start

public boolean start(int port)

Call this to attempt to connect to the server.

Parameters:

port - where the server is listening. Since it launched this client, it should have either been passed to it on the command line or via a system property (-D).

Returns:

true if we connected to the server, false if not.

stop

public void stop()

Call this to stop communications with the server.

sendMessage

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

Call this to send a message with some binary data. The protocal and the server must understand the message, message type, and data.

Parameters:

messageType - the message type. Whatever the client and server want.

message - the message being sent

data - the data being sent. Must be serializable.

Returns:

true if we sent the message, false if not.

sendMessage

public boolean sendMessage(String messageType,
                  String message)

sendMessageWaitForReply

public MessageObject sendMessageWaitForReply(String messageType,
                                    String message,
                                    Serializable data)

Call this to send a message with some binary data and wait for the server's acknowledgement. The protocol and the server must understand the message, message type, and data.

Parameters:

messageType - the message type. Whatever the client and server want.

message - the message being sent

data - the data being sent. Must be serializable.

Returns:

the reply from the server

readMessage

public MessageObject readMessage()

Call this to listen for a message from the server. This is really only meant to be a response from the server as a response to our message.

Returns:

the message returned.