org.gradle.foundation.ipc.basic

Class Server<P extends Server.Protocol,O extends Server.ServerObserver>

java.lang.Object

org.gradle.foundation.ipc.basic.Server<P,O>

Direct Known Subclasses:

ProcessLauncherServer

public class Server<P extends Server.Protocol,O extends Server.ServerObserver>
extends Object

This is a server that talks to a client via sockets (Rudimentary form of Inter-Process Communication (IPC)). This does the work of locating a free socket and starting the connection. To use this, you really only have to define a Protocol that handles the actual messages. You'll want to make your client startup a ClientProcess object that implements a corresponding Protocol.

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Server.Protocol<S extends Server> Implement this to define the behavior of the communication on the server side.
static interface	Server.ServerObserver

Field Summary

Fields

Modifier and Type	Field and Description
protected ObserverLord<O>	observerLord
protected P	protocol

Constructor Summary

Constructors

Constructor and Description
Server(P protocol)

Method Summary

Methods

Modifier and Type	Method and Description
void	addServerObserver(O observer, boolean inEventQueue)
protected void	communicationsStarted() this exists solely so it can be overridden.
int	getPort()
boolean	isServerRunning()
void	removeServerObserver(O observer)
void	requestShutdown()
void	sendMessage(String messageType, String message) Call this to send a message.
void	sendMessage(String messageType, String message, Serializable data) Call this to send a message with some binary data.
boolean	start() Call this to start the server.
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

protocol

protected P extends Server.Protocol protocol

observerLord

protected ObserverLord<O extends Server.ServerObserver> observerLord

Constructor Detail

Server

public Server(P protocol)

Method Detail

getPort

public int getPort()

start

public boolean start()

Call this to start the server.

Returns:

true if we started, false if not.

communicationsStarted

protected void communicationsStarted()

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.

requestShutdown

public void requestShutdown()

isServerRunning

public boolean isServerRunning()

sendMessage

public void sendMessage(String messageType,
               String message)

Call this to send a message. The protocal and the client must understand the message and message type.

Parameters:

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

message - the message being sent.

sendMessage

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

Call this to send a message with some binary data. The protocal and the client 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.

stop

public void stop()

addServerObserver

public void addServerObserver(O observer,
                     boolean inEventQueue)

removeServerObserver

public void removeServerObserver(O observer)