rescuecore2.connection

Class AbstractConnection

java.lang.Object

rescuecore2.connection.AbstractConnection

All Implemented Interfaces:

Connection

Direct Known Subclasses:

StreamConnection

public abstract class AbstractConnection
extends java.lang.Object
implements Connection

Abstract base class for Connection implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractConnection.State The state of this connection: either not yet started, started or shut down.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConnection() Construct an abstract connection.

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(ConnectionListener l) Add a ConnectionListener.
protected void	bytesReceived(byte[] b) Process some bytes that were received.
protected void	fireMessageReceived(Message m) Fire a messageReceived event to all registered listeners.
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.
protected abstract void	sendBytes(byte[] b) Send some bytes to the other end of the connection.
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 newName) Set the name for this connection.
void	setRegistry(Registry r) Set the Registry that this connection should use for decoding messages and entities.
void	shutdown() Shut this connection down.
protected abstract void	shutdownImpl() Perform shutdown actions.
void	startup() Start this connection up.
protected abstract void	startupImpl() Perform startup actions.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConnection

protected AbstractConnection()

Construct an abstract connection.

Method Detail

setLogBytes

public void setLogBytes(boolean enabled)

Description copied from interface: Connection

Turn byte-level logging on or off.

Specified by:

setLogBytes in interface Connection

Parameters:

enabled - Whether to enable byte-level logging.

startup

public final void startup()

Description copied from interface: Connection

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

Specified by:

startup in interface Connection

shutdown

public final void shutdown()

Description copied from interface: Connection

Shut this connection down.

Specified by:

shutdown in interface Connection

isAlive

public boolean isAlive()

Description copied from interface: Connection

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.

Specified by:

isAlive in interface Connection

Returns:

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

addConnectionListener

public void addConnectionListener(ConnectionListener l)

Description copied from interface: Connection

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

Specified by:

addConnectionListener in interface Connection

Parameters:

l - The listener to add.

removeConnectionListener

public void removeConnectionListener(ConnectionListener l)

Description copied from interface: Connection

Remove a ConnectionListener.

Specified by:

removeConnectionListener in interface Connection

Parameters:

l - The listener to remove.

sendMessage

public void sendMessage(Message msg)
                 throws ConnectionException

Description copied from interface: Connection

Send a message across this connection.

Specified by:

sendMessage in interface 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

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

Description copied from interface: Connection

Send a set of messages across this connection.

Specified by:

sendMessages in interface 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.

setRegistry

public void setRegistry(Registry r)

Description copied from interface: Connection

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

Specified by:

setRegistry in interface Connection

Parameters:

r - The new Registry to use.

getRegistry

public Registry getRegistry()

Description copied from interface: Connection

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

Specified by:

getRegistry in interface Connection

Returns:

The Registry in use.

getName

public java.lang.String getName()

Description copied from interface: Connection

Get the name for this connection.

Specified by:

getName in interface Connection

Returns:

The name.

setName

public void setName(java.lang.String newName)

Description copied from interface: Connection

Set the name for this connection.

Specified by:

setName in interface Connection

Parameters:

newName - The new name.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

sendBytes

protected abstract void sendBytes(byte[] b)
                           throws java.io.IOException

Send some bytes to the other end of the connection.

Parameters:

b - The bytes to send.

Throws:

java.io.IOException - If the data cannot be sent.

startupImpl

protected abstract void startupImpl()

Perform startup actions. This will only ever be called once.

shutdownImpl

protected abstract void shutdownImpl()

Perform shutdown actions. This will only ever be called once.

bytesReceived

protected void bytesReceived(byte[] b)

Process some bytes that were received. The default implementation will use the Registry to decode all messages in the buffer and send them to listeners.

Parameters:

b - The received bytes.

fireMessageReceived

protected void fireMessageReceived(Message m)

Fire a messageReceived event to all registered listeners.

Parameters:

m - The message that was received.