rsb.util

Class EventQueueAdapter

java.lang.Object

rsb.AbstractEventHandler

rsb.util.EventQueueAdapter

All Implemented Interfaces:

EventListener, Handler

public class EventQueueAdapter
extends AbstractEventHandler

An adapter similar to the QueueAdapter that provides access to a queue of RSB Events instead of directly to the payload data. It can also be directly registered as handler in an rsb.Listener instance and used for receiving and storing dispatched events.

Author:

dklotz

Constructor Summary

Constructors

Constructor and Description
EventQueueAdapter() Creates an adapter with a preset unlimited queue inside.
EventQueueAdapter(BlockingQueue<Event> queue) Creates an adapter with the given queue implementation.
EventQueueAdapter(int capacity, boolean discardOldest) Creates an adapter with a preset queue inside that is limited to capacity elements.

Method Summary

Methods

Modifier and Type	Method and Description
BlockingQueue<Event>	getQueue() Provides access to the queue filled by this queue adapter.
void	handleEvent(Event event) Shall implement the real handling logic for an event.

Methods inherited from class rsb.AbstractEventHandler

internalNotify

Methods inherited from class java.lang.Object

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

Constructor Detail

EventQueueAdapter

public EventQueueAdapter()

Creates an adapter with a preset unlimited queue inside.

EventQueueAdapter

public EventQueueAdapter(int capacity,
                 boolean discardOldest)

Creates an adapter with a preset queue inside that is limited to capacity elements.

Parameters:

capacity - capacity of the internal queue

discardOldest - if true, remove older events if the queue is full, otherwise block until space is available on inserts

EventQueueAdapter

public EventQueueAdapter(BlockingQueue<Event> queue)

Creates an adapter with the given queue implementation.

Parameters:

queue - The queue this adapter should fill.

Method Detail

handleEvent

public void handleEvent(Event event)

Description copied from class: AbstractEventHandler

Shall implement the real handling logic for an event.

Specified by:

handleEvent in class AbstractEventHandler

Parameters:

event - the event to handle

getQueue

public BlockingQueue<Event> getQueue()

Provides access to the queue filled by this queue adapter.

Returns:

The current with the events received by this adapter.