org.gradle.foundation.ipc.basic

Interface Server.Protocol<S extends Server>

All Known Subinterfaces:

ProcessLauncherServer.Protocol

All Known Implementing Classes:

AbstractGradleServerProtocol, ExecuteGradleCommandServerProtocol, KillGradleServerProtocol, TaskListServerProtocol

Enclosing class:

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

public static interface Server.Protocol<S extends Server>

Implement this to define the behavior of the communication on the server side.

Method Summary

Methods

Modifier and Type	Method and Description
void	clientCommunicationStopped() Notification that the client has stopped all communications.
void	connectionAccepted() Notification that the connection was accepted by the client.
boolean	continueConnection()
void	initialize(S server) Gives your protocol a chance to store this server so it can access its functions.
void	messageReceived(MessageObject message) Notification that a message has been received.
void	readFailureOccurred() Notification that a read failure occurred.

Method Detail

initialize

void initialize(S server)

Gives your protocol a chance to store this server so it can access its functions.

connectionAccepted

void connectionAccepted()

Notification that the connection was accepted by the client.

continueConnection

boolean continueConnection()

Returns:

true if we should keep the connection alive. False if we should stop communication.

messageReceived

void messageReceived(MessageObject message)

Notification that a message has been received.

Parameters:

message - the message that was received.

clientCommunicationStopped

void clientCommunicationStopped()

Notification that the client has stopped all communications.

readFailureOccurred

void readFailureOccurred()

Notification that a read failure occurred. This really only exists for debugging purposes when things go wrong.