net.grinder.console.communication

Interface ConsoleCommunication

All Known Implementing Classes:

ConsoleCommunicationImplementation

public interface ConsoleCommunication

Handles communication for the console.

Author:

Philip Aston

Method Summary

Methods

Modifier and Type	Method and Description
MessageDispatchRegistry	getMessageDispatchRegistry() Returns the message dispatch registry which callers can use to register new message handlers.
boolean	processOneMessage() Wait to receive a message, then process it.
void	sendToAddressedAgents(Address address, Message message) Send the given message to the given agent processes (which may pass it on to its workers).
void	sendToAgents(Message message) Send the given message to the agent processes (which may pass it on to their workers).
void	shutdown() Shut down communication.

Method Detail

getMessageDispatchRegistry

MessageDispatchRegistry getMessageDispatchRegistry()

Returns the message dispatch registry which callers can use to register new message handlers.

Returns:

The registry.

shutdown

void shutdown()

Shut down communication.

processOneMessage

boolean processOneMessage()

Wait to receive a message, then process it.

Returns:

true if we processed a message successfully; false if we've been shut down.

See Also:

shutdown()

sendToAgents

void sendToAgents(Message message)

Send the given message to the agent processes (which may pass it on to their workers).

Parameters:

message - The message to send.

sendToAddressedAgents

void sendToAddressedAgents(Address address,
                         Message message)

Send the given message to the given agent processes (which may pass it on to its workers).

Parameters:

address - The address to which the message should be sent.

message - The message to send.