rsb

Class Listener

java.lang.Object

rsb.Participant

rsb.Listener

All Implemented Interfaces:

RSBObject

public class Listener
extends Participant

This class implements the receiving part of the Inform-Listen (n:m) communication pattern offered by RSB. Upon creation the Listener instance has to be provided with the scope of the channel to listen to. The Listener uses the common event handling mechanisms to process incoming events - in particular filtering of incoming events. Each time a event is received from an Informer, an Event object is dispatched to all Handlers associated to the Listener.

Author:

swrede, jschaefe, jwienke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Listener.ListenerStateActive
protected class	Listener.ListenerStateInactive

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.logging.Logger	LOG

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates all network resources that belong to a specific object.
void	addFilter(Filter filter)
void	addHandler(Handler handler, boolean wait) Register an event handler on this Listener to be notified about incoming events.
void	deactivate() Deactivate all network resources that are owned by a specific object in order to reactivate it.
java.util.Iterator<Filter>	getFilterIterator()
java.util.List<Filter>	getFilters()
java.util.Iterator<Handler>	getHandlerIterator()
java.util.List<Handler>	getHandlers()
boolean	isActive() Tells wether this class is currently active or not.
void	removeHandler(Handler handler, boolean wait) Remove an event listener from this Listener.
void	setErrorHandler(ErrorHandler handler) Deprecated. not yet designed

Methods inherited from class rsb.Participant

getId, getRouter, getScope, getTransportFactory

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final java.util.logging.Logger LOG

Method Detail

activate

public void activate()
              throws InitializeException

Description copied from interface: RSBObject

Activates all network resources that belong to a specific object.

Throws:

InitializeException

deactivate

public void deactivate()

Description copied from interface: RSBObject

Deactivate all network resources that are owned by a specific object in order to reactivate it.

getFilters

public java.util.List<Filter> getFilters()

getFilterIterator

public java.util.Iterator<Filter> getFilterIterator()

addFilter

public void addFilter(Filter filter)

getHandlers

public java.util.List<Handler> getHandlers()

getHandlerIterator

public java.util.Iterator<Handler> getHandlerIterator()

addHandler

public void addHandler(Handler handler,
              boolean wait)

Register an event handler on this Listener to be notified about incoming events. All received events will be send to the registered listeners.

Parameters:

handler - the handler instance to be registered

wait - if set to @c true, this method will return only after the handler has completely been installed and will receive the next available message. Otherwise it may return earlier.

removeHandler

public void removeHandler(Handler handler,
                 boolean wait)
                   throws java.lang.InterruptedException

Remove an event listener from this Listener.

Parameters:

handler - the listener instance to be removed.

wait - if set to @c true, this method will return only after the handler has been completely removed from the event processing and will not be called anymore from this listener.

Throws:

java.lang.InterruptedException - thrown if the method is interrupted while waiting for the handler to be removed

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

Deprecated. not yet designed

isActive

public boolean isActive()

Description copied from interface: RSBObject

Tells wether this class is currently active or not.

Returns:

true if active