rsb.eventprocessing

Class SingleThreadEventReceivingStrategy

java.lang.Object

rsb.eventprocessing.SingleThreadEventReceivingStrategy

All Implemented Interfaces:

Activatable, EventReceivingStrategy, EventHandler

public class SingleThreadEventReceivingStrategy
extends Object
implements EventReceivingStrategy

An EventReceivingStrategy that uses a single thread for all handlers.

Author:

jwienke

Nested Class Summary

Nested classes/interfaces inherited from interface rsb.Activatable

Activatable.State

Constructor Summary

Constructors

Constructor and Description
SingleThreadEventReceivingStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates all resources that belong to a specific object.
void	addFilter(Filter filter) Adds a filter that is applied for all registered handlers some time after this method call.
void	addHandler(Handler handler, boolean wait) Registers a handler that will be informed in case of received events.
void	deactivate() Deactivate all resources that are owned by a specific object in order to correctly tear down.
void	handle(Event event) The callback method.
boolean	isActive() Tells whether this class is currently active or not.
void	removeFilter(Filter filter) Removes a filter that is remove for all registered handlers some time after this method call.
void	removeHandler(Handler handler, boolean wait) Removes a handler from the event dispatching.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleThreadEventReceivingStrategy

public SingleThreadEventReceivingStrategy()

Method Detail

handle

public void handle(Event event)

Description copied from interface: EventHandler

The callback method.

Specified by:

handle in interface EventHandler

Parameters:

event - the event to handle

addFilter

public void addFilter(Filter filter)

Description copied from interface: EventReceivingStrategy

Adds a filter that is applied for all registered handlers some time after this method call.

Specified by:

addFilter in interface EventReceivingStrategy

Parameters:

filter - filter to add, not null

removeFilter

public void removeFilter(Filter filter)

Description copied from interface: EventReceivingStrategy

Removes a filter that is remove for all registered handlers some time after this method call.

Specified by:

removeFilter in interface EventReceivingStrategy

Parameters:

filter - filter to remove, not null

addHandler

public void addHandler(Handler handler,
              boolean wait)

Description copied from interface: EventReceivingStrategy

Registers a handler that will be informed in case of received events.

Specified by:

addHandler in interface EventReceivingStrategy

Parameters:

handler - the handler to add, not null

wait - if true, wait with returning from this method until the handler is fully functional and will receive the next issued event

removeHandler

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

Description copied from interface: EventReceivingStrategy

Removes a handler from the event dispatching. In case the given handler was not registered the call is silently ignored.

Specified by:

removeHandler in interface EventReceivingStrategy

Parameters:

handler - the handler to remove

wait - if true, wait with returning from this method until the handler cannot receive any more events

Throws:

InterruptedException - interrupted while waiting for the handler to be removed

activate

public void activate()

Description copied from interface: Activatable

Activates all resources that belong to a specific object.

Specified by:

activate in interface Activatable

deactivate

public void deactivate()
                throws InterruptedException

Description copied from interface: Activatable

Deactivate all resources that are owned by a specific object in order to correctly tear down. The method should only return once the object is completely deactivated including possible background threads.

Specified by:

deactivate in interface Activatable

Throws:

InterruptedException - interrupted while waiting for proper deactivation. Object might be in an undefined state now

isActive

public boolean isActive()

Description copied from interface: Activatable

Tells whether this class is currently active or not.

Specified by:

isActive in interface Activatable

Returns:

true if active