net.grinder.communication

Interface Receiver

All Known Implementing Classes:

ClientReceiver, ServerReceiver, StreamReceiver

public interface Receiver

Interface for classes that manage the receipt of messages.

Author:

Philip Aston

Method Summary

Methods

Modifier and Type	Method and Description
void	shutdown() Shut down this receiver.
Message	waitForMessage() Block until a message is available, or another thread has called shutdown().

Method Detail

waitForMessage

Message waitForMessage()
                       throws CommunicationException

Block until a message is available, or another thread has called shutdown(). Typically called from a message dispatch loop.

Multiple threads can call this method, but only one thread will receive a given message.

Returns:

The message or null if shut down.

Throws:

CommunicationException - If an IO exception occurs reading the message.

shutdown

void shutdown()

Shut down this receiver.