org.gradle.messaging.remote.internal

Class ReceiveProtocol

java.lang.Object

org.gradle.messaging.remote.internal.ReceiveProtocol

All Implemented Interfaces:

Protocol<Message>

public class ReceiveProtocol
extends Object
implements Protocol<Message>

Constructor Summary

Constructors

Constructor and Description
ReceiveProtocol(Object id, String displayName, String channelKey)

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiveProtocol

public ReceiveProtocol(Object id,
               String displayName,
               String channelKey)

Method Detail

start

public void start(ProtocolContext<Message> context)

Description copied from interface: Protocol

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

Specified by:

start in interface Protocol<Message>

Parameters:

context - The context.

handleIncoming

public void handleIncoming(Message message)

Description copied from interface: Protocol

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

Specified by:

handleIncoming in interface Protocol<Message>

handleOutgoing

public void handleOutgoing(Message message)

Description copied from interface: Protocol

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

Specified by:

handleOutgoing in interface Protocol<Message>

stopRequested

public void stopRequested()

Description copied from interface: Protocol

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.

Specified by:

stopRequested in interface Protocol<Message>