repicea.net

Class RemoteEventManager

java.lang.Object

repicea.net.RemoteEventManager

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

ServerSideRemoteEventConnector

public abstract class RemoteEventManager
extends java.lang.Object
implements java.io.Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RemoteEventManager.InternalCall

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoteEventManager(SocketWrapper socket)

Method Summary

Modifier and Type	Method and Description
protected void	addToSendingQueue(java.io.Serializable object)
void	close()
protected void	connectListenerAndObject(java.lang.Object obj, RemoteListener listener) This method should be used to match the objects and the listeners.
abstract void	connectRemoteListeners() This method connects the remote listeners to the appropriate object.
protected java.util.List<RemoteListener>	getRemoteListeners() This method returns the remote listeners.
protected void	registerListeners(java.util.List<java.util.EventListener> listeners) This class register the local listeners and sends the associated remote listeners through the socket.
void	sendLocalListeners(java.util.List<java.util.EventListener> listeners) This method sends the local listeners.
protected void	waitForCloseCall() This method makes the main thread waits for the receiver and the sender threads to die.
protected void	whatShouldIDoWithThisObjectIJustReceived(java.lang.Object obj) This method already handles object that are either RemoteEvent instance and List of RemoteListener instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteEventManager

protected RemoteEventManager(SocketWrapper socket)

Method Detail

registerListeners

protected void registerListeners(java.util.List<java.util.EventListener> listeners)
                          throws java.io.IOException

This class register the local listeners and sends the associated remote listeners through the socket.

Parameters:

listeners - a List of Event Listener

Throws:

java.io.IOException - if the remote listeners cannot be sent through the socket

getRemoteListeners

protected java.util.List<RemoteListener> getRemoteListeners()
                                                     throws java.lang.InterruptedException

This method returns the remote listeners. It blocks if the remote listeners are not set already.

Returns:

a List of remoteListeners

Throws:

java.lang.InterruptedException - if the lock is interrupted for unknown reason

whatShouldIDoWithThisObjectIJustReceived

protected void whatShouldIDoWithThisObjectIJustReceived(java.lang.Object obj)

This method already handles object that are either RemoteEvent instance and List of RemoteListener instances. It can be overriden in derived class in order to handle objects from other classes.

Parameters:

obj - an instance from unknown instance

sendLocalListeners

public void sendLocalListeners(java.util.List<java.util.EventListener> listeners)
                        throws java.io.IOException

This method sends the local listeners. By default, it runs the registerListener method. It can be overriden to implement additional operations.

Parameters:

listeners - a List of EventListener instances

Throws:

java.io.IOException

connectRemoteListeners

public abstract void connectRemoteListeners()
                                     throws java.lang.Exception

This method connects the remote listeners to the appropriate object.

Throws:

java.lang.Exception

connectListenerAndObject

protected void connectListenerAndObject(java.lang.Object obj,
                                        RemoteListener listener)
                                 throws java.lang.Exception

This method should be used to match the objects and the listeners. It automatically finds out the appropriate method and records the match in a list for further removal when the close method is called.

Parameters:

obj - the object that produces the events

listener - a RemoteListener instance

Throws:

java.lang.Exception - if the method does not exist or cannot be accessed.

addToSendingQueue

protected void addToSendingQueue(java.io.Serializable object)

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

waitForCloseCall

protected void waitForCloseCall()
                         throws java.lang.InterruptedException

This method makes the main thread waits for the receiver and the sender threads to die. When they do, the method calls close.

Throws:

java.lang.InterruptedException

java.io.IOException