org.gradle.messaging.remote.internal

Interface Protocol<T>

Type Parameters:

T - The message type.

All Known Implementing Classes:

BroadcastSendProtocol, BufferingProtocol, ChannelLookupProtocol, ChannelRegistrationProtocol, ReceiveProtocol, RemoteDisconnectProtocol, SendProtocol, UnicastSendProtocol, WorkerProtocol

public interface Protocol<T>

A protocol implementation. A protocol is a stage in a bi-directional messaging pipeline. It can receive incoming and outgoing messages. In response to these messages, it can dispatch incoming and outgoing messages. It can also register callbacks to be executed later, to allow timeouts and periodic behaviour to be implemented.

All methods on protocol are called from a single thread at a time, so implementations do not have to use any locking for their state. The method implementations should not block.

Method Summary

Methods

Modifier and Type	Method and Description
void	handleIncoming(T message) Handles an incoming message.
void	handleOutgoing(T message) Handles an outgoing message.
void	start(ProtocolContext<T> context) Called to initialise the protocol.
void	stopRequested() Requests that this protocol initiate its stop messages.

Method Detail

start

void start(ProtocolContext<T> context)

Called to initialise the protocol. The supplied context can be later used to dispatch incoming and outgoing messages.

Parameters:

context - The context.

handleOutgoing

void handleOutgoing(T message)

Handles an outgoing message. The context can be used to dispatch incoming and outgoing messages, as required.

handleIncoming

void handleIncoming(T message)

Handles an incoming message. The context can be used to dispatch incoming and outgoing messages, as required.

stopRequested

void stopRequested()

Requests that this protocol initiate its stop messages. The protocol can call ProtocolContext.stopLater() to defer stop until some messages are received. In which case, it should later call ProtocolContext.stopped() to indicate it has finished. If the protocol does not call stopLater(), it is assumed to have stopped when this method returns.