net.grinder.communication

Class StreamReceiver

java.lang.Object

net.grinder.communication.StreamReceiver

All Implemented Interfaces:

Receiver

Direct Known Subclasses:

ClientReceiver

public class StreamReceiver
extends Object
implements Receiver

Manages receipt of messages from a server over a stream.

Author:

Philip Aston

Constructor Summary

Constructors

Constructor and Description
StreamReceiver(InputStream inputStream) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	shutdown() Cleanly shut down the Receiver.
Message	waitForMessage() Block until a message is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamReceiver

public StreamReceiver(InputStream inputStream)

Constructor.

Parameters:

inputStream - The input stream to read from.

Method Detail

waitForMessage

public final Message waitForMessage()
                             throws CommunicationException

Block until a message is available. Typically called from a message dispatch loop.

Specified by:

waitForMessage in interface Receiver

Returns:

The message or null if shut down.

Throws:

CommunicationException - If an error occurred receiving a message.

shutdown

public void shutdown()

Cleanly shut down the Receiver. Ignore errors, connection has probably been reset by peer.

Specified by:

shutdown in interface Receiver