net.grinder.engine.communication

Class ConsoleListener

java.lang.Object

net.grinder.engine.communication.ConsoleListener

public final class ConsoleListener
extends Object

Process console messages and allows them to be asynchronously queried.

Author:

Philip Aston

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANY Constant that represent any message.
static int	RESET Constant that represents a a reset message.
static int	SHUTDOWN Constant that represents a communication shutdown.
static int	START Constant that represents start message.
static int	STOP Constant that represents a stop message.

Constructor Summary

Constructors

Constructor and Description
ConsoleListener(Condition notifyOnMessage, org.slf4j.Logger logger) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkForMessage(int mask) Check for messages matching the given mask.
void	discardMessages(int mask) Discard pending messages that match the given mask.
StartGrinderMessage	getLastStartGrinderMessage() Return the last StartGrinderMessage received.
boolean	received(int mask) Query the messages set up by the last checkForMessage(int) or waitForMessage() call.
void	registerMessageHandlers(MessageDispatchRegistry messageDispatcher) Registers message handlers with a dispatcher.
void	shutdown() Shut down.
void	waitForMessage() Wait until any message is received.

Methods inherited from class java.lang.Object

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

Field Detail

START

public static final int START

Constant that represents start message.

See Also:

received(int), Constant Field Values

RESET

public static final int RESET

Constant that represents a a reset message.

See Also:

received(int), Constant Field Values

STOP

public static final int STOP

Constant that represents a stop message.

See Also:

received(int), Constant Field Values

SHUTDOWN

public static final int SHUTDOWN

Constant that represents a communication shutdown.

See Also:

received(int), Constant Field Values

ANY

public static final int ANY

Constant that represent any message.

See Also:

received(int), Constant Field Values

Constructor Detail

ConsoleListener

public ConsoleListener(Condition notifyOnMessage,
               org.slf4j.Logger logger)

Constructor.

Parameters:

notifyOnMessage - An Object to notify when a message arrives.

logger - A @ code Logger} to which received event messages are loggged.

Method Detail

shutdown

public void shutdown()

Shut down.

waitForMessage

public void waitForMessage()

Wait until any message is received.

After calling this method, the actual messages can be determined using received(int).

checkForMessage

public boolean checkForMessage(int mask)

Check for messages matching the given mask.

After calling this method, the actual messages can be determined using received(int).

Parameters:

mask - The messages to check for.

Returns:

true if at least one message matches the mask parameter has been received since the last time the message was checked for, or if communications have been shutdown. false otherwise.

discardMessages

public void discardMessages(int mask)

Discard pending messages that match the given mask.

Parameters:

mask - The messages to discard.

received

public boolean received(int mask)

Query the messages set up by the last checkForMessage(int) or waitForMessage() call.

Parameters:

mask - The messages to check for.

Returns:

true if one or more of the received messages matches mask.

registerMessageHandlers

public void registerMessageHandlers(MessageDispatchRegistry messageDispatcher)

Registers message handlers with a dispatcher.

Parameters:

messageDispatcher - The dispatcher.

getLastStartGrinderMessage

public StartGrinderMessage getLastStartGrinderMessage()

Return the last StartGrinderMessage received.

Returns:

The message.