org.gradle.foundation.ipc.basic

Class ProcessLauncherServer

java.lang.Object

org.gradle.foundation.ipc.basic.Server<ProcessLauncherServer.Protocol,ProcessLauncherServer.ServerObserver>

org.gradle.foundation.ipc.basic.ProcessLauncherServer

public class ProcessLauncherServer
extends Server<ProcessLauncherServer.Protocol,ProcessLauncherServer.ServerObserver>

This launches an application as a separate process then listens for messages from it. You implement the Protocol interface to handle the specifics of the communications. To use this, instantiate it, then call start. When the communications are finished, call requestShutdown(). Your server's protocol can call sendMessage once communication is started to respond to client's messages.

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProcessLauncherServer.Protocol Implement this to define the behavior of the communication on the server side.
static interface	ProcessLauncherServer.ServerObserver

Field Summary

Fields inherited from class org.gradle.foundation.ipc.basic.Server

observerLord, protocol

Constructor Summary

Constructors

Constructor and Description
ProcessLauncherServer(ProcessLauncherServer.Protocol protocol)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	communicationsStarted() this exists solely so it can be overridden.
void	killProcess() Call this to violently kill the external process.
void	setExternalProcess(ExecHandle externalProcess)
void	stop()

Methods inherited from class org.gradle.foundation.ipc.basic.Server

addServerObserver, getPort, isServerRunning, removeServerObserver, requestShutdown, sendMessage, sendMessage, start

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessLauncherServer

public ProcessLauncherServer(ProcessLauncherServer.Protocol protocol)

Method Detail

communicationsStarted

protected void communicationsStarted()

Description copied from class: Server

this exists solely so it can be overridden. Its an internal notification that communcations have started. You may want to do some extra processing now.

Overrides:

communicationsStarted in class Server<ProcessLauncherServer.Protocol,ProcessLauncherServer.ServerObserver>

stop

public void stop()

Overrides:

stop in class Server<ProcessLauncherServer.Protocol,ProcessLauncherServer.ServerObserver>

setExternalProcess

public void setExternalProcess(ExecHandle externalProcess)

killProcess

public void killProcess()

Call this to violently kill the external process. This is NOT a good way to stop it. It is preferable to ask the thread to stop. However, gradle has no way to do that, so we'll be killing it.