rescuecore2.connection

Interface Connection

All Known Implementing Classes:

AbstractConnection, StreamConnection, TCPConnection

public interface Connection

Top-level interface for a communication interface between simulator components.

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(ConnectionListener l) Add a ConnectionListener.
java.lang.String	getName() Get the name for this connection.
Registry	getRegistry() Get the Registry that this connection is using for decoding messages and entities.
boolean	isAlive() Find out if this connection is still alive.
void	removeConnectionListener(ConnectionListener l) Remove a ConnectionListener.
void	sendMessage(Message msg) Send a message across this connection.
void	sendMessages(java.util.Collection<? extends Message> messages) Send a set of messages across this connection.
void	setLogBytes(boolean enabled) Turn byte-level logging on or off.
void	setName(java.lang.String name) Set the name for this connection.
void	setRegistry(Registry registry) Set the Registry that this connection should use for decoding messages and entities.
void	shutdown() Shut this connection down.
void	startup() Start this connection up.

Method Detail

sendMessage

void sendMessage(Message msg)
          throws ConnectionException

Send a message across this connection.

Parameters:

msg - The message to send.

Throws:

ConnectionException - If the connection has not been started up or has been shut down, or if there is an error sending the message.

sendMessages

void sendMessages(java.util.Collection<? extends Message> messages)
           throws ConnectionException

Send a set of messages across this connection.

Parameters:

messages - The messages to send.

Throws:

ConnectionException - If the connection has not been started up or has been shut down, or if there is an error sending the message.

addConnectionListener

void addConnectionListener(ConnectionListener l)

Add a ConnectionListener. This listener will be notified when messages arrive on this connection.

Parameters:

l - The listener to add.

removeConnectionListener

void removeConnectionListener(ConnectionListener l)

Remove a ConnectionListener.

Parameters:

l - The listener to remove.

startup

void startup()

Start this connection up. Connections are not available for use until started.

isAlive

boolean isAlive()

Find out if this connection is still alive. The connection is alive if it has been started, not stopped, and no fatal errors have occurred.

Returns:

True if this connection is alive and is still able to send/receive messages, false otherwise.

shutdown

void shutdown()

Shut this connection down.

setLogBytes

void setLogBytes(boolean enabled)

Turn byte-level logging on or off.

Parameters:

enabled - Whether to enable byte-level logging.

setName

void setName(java.lang.String name)

Set the name for this connection.

Parameters:

name - The new name.

getName

java.lang.String getName()

Get the name for this connection.

Returns:

The name.

setRegistry

void setRegistry(Registry registry)

Set the Registry that this connection should use for decoding messages and entities.

Parameters:

registry - The new Registry to use.

getRegistry

Registry getRegistry()

Get the Registry that this connection is using for decoding messages and entities.

Returns:

The Registry in use.