Package gov.aps.jca.event

Class QueuedEventDispatcher

java.lang.Object

gov.aps.jca.event.AbstractEventDispatcher

gov.aps.jca.event.QueuedEventDispatcher

All Implemented Interfaces:

Configurable, EventDispatcher, Runnable

public class QueuedEventDispatcher
extends AbstractEventDispatcher
implements Runnable, Configurable

This EventDispatcher uses an internal thread to dispatch events.

Version:

1.0

Author:

Eric Boucher

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	_count
protected Thread	_dispatcherThread
protected boolean	_killed
protected int	_limit
protected int	_priority
protected List	_queue
protected int	_queueLimit
protected Map	_sourcesEventCount

Constructor Summary

Constructors

Constructor	Description
QueuedEventDispatcher()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration conf)	Pass the Configuration to the Configurable class.
void	dispatch(AccessRightsEvent ev, AccessRightsListener arl)
void	dispatch(AccessRightsEvent ev, List listeners)
void	dispatch(ConnectionEvent ev, ConnectionListener cl)
void	dispatch(ConnectionEvent ev, List listeners)
void	dispatch(ContextExceptionEvent ev, ContextExceptionListener cel)
void	dispatch(ContextExceptionEvent ev, List listeners)
void	dispatch(ContextMessageEvent ev, ContextMessageListener cml)
void	dispatch(ContextMessageEvent ev, List listeners)
void	dispatch(GetEvent ev, GetListener gl)
void	dispatch(GetEvent ev, List listeners)
void	dispatch(MonitorEvent ev, MonitorListener ml)
void	dispatch(MonitorEvent ev, List listeners)
void	dispatch(PutEvent ev, PutListener pl)
void	dispatch(PutEvent ev, List listeners)
void	dispose()
int	getPriority()
protected void	nonBlockingQueueEvent(gov.aps.jca.event.QueuedEventDispatcher.Event ev)
protected void	queueEvent(gov.aps.jca.event.QueuedEventDispatcher.Event ev)
protected void	queueEvent(gov.aps.jca.event.QueuedEventDispatcher.Event ev, boolean doNotBlockRequired)
void	run()	Process events in the queue as they are added.
void	setPriority(int priority)

Methods inherited from class java.lang.Object

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

Field Detail

_count

protected static int _count

_killed

protected volatile boolean _killed

_priority

protected int _priority

_dispatcherThread

protected Thread _dispatcherThread

_queue

protected List _queue

_queueLimit

protected int _queueLimit

_sourcesEventCount

protected Map _sourcesEventCount

_limit

protected int _limit

Constructor Detail

QueuedEventDispatcher

public QueuedEventDispatcher()

Method Detail

nonBlockingQueueEvent

protected void nonBlockingQueueEvent(gov.aps.jca.event.QueuedEventDispatcher.Event ev)

queueEvent

protected void queueEvent(gov.aps.jca.event.QueuedEventDispatcher.Event ev)

queueEvent

protected void queueEvent(gov.aps.jca.event.QueuedEventDispatcher.Event ev,
                          boolean doNotBlockRequired)

run

public void run()

Process events in the queue as they are added. The queue must be synchronized for thread safety but we must be careful not to block for too long or else new events get blocked from being added to the queue causing long delays. The design is to process events in batches. This allows for the most efficient use of computer cycles since much of the time the queue will not be blocked. This method was modified by tap on 6/17/2004 to allow both efficient event processing and thread safety. Later optimized by msekoranja.

Specified by:

run in interface Runnable

dispose

public void dispose()

Specified by:

dispose in interface EventDispatcher

Overrides:

dispose in class AbstractEventDispatcher

configure

public void configure(Configuration conf)
               throws ConfigurationException

Description copied from interface: Configurable

Pass the Configuration to the Configurable class. This method must always be called after the constructor and before any other method.

Specified by:

configure in interface Configurable

Parameters:

conf - the class configurations.

Throws:

ConfigurationException - if an error occurs

getPriority

public int getPriority()

setPriority

public void setPriority(int priority)

dispatch

public void dispatch(ContextMessageEvent ev,
                     List listeners)

Specified by:

dispatch in interface EventDispatcher

dispatch

public void dispatch(ContextExceptionEvent ev,
                     List listeners)

Specified by:

dispatch in interface EventDispatcher

dispatch

public void dispatch(ConnectionEvent ev,
                     List listeners)

Specified by:

dispatch in interface EventDispatcher

dispatch

public void dispatch(AccessRightsEvent ev,
                     List listeners)

Specified by:

dispatch in interface EventDispatcher

dispatch

public void dispatch(MonitorEvent ev,
                     List listeners)

Specified by:

dispatch in interface EventDispatcher

dispatch

public void dispatch(GetEvent ev,
                     List listeners)

Specified by:

dispatch in interface EventDispatcher

dispatch

public void dispatch(PutEvent ev,
                     List listeners)

Specified by:

dispatch in interface EventDispatcher

dispatch

public void dispatch(ContextMessageEvent ev,
                     ContextMessageListener cml)

Specified by:

dispatch in interface EventDispatcher

Overrides:

dispatch in class AbstractEventDispatcher

dispatch

public void dispatch(ContextExceptionEvent ev,
                     ContextExceptionListener cel)

Specified by:

dispatch in interface EventDispatcher

Overrides:

dispatch in class AbstractEventDispatcher

dispatch

public void dispatch(ConnectionEvent ev,
                     ConnectionListener cl)

Specified by:

dispatch in interface EventDispatcher

Overrides:

dispatch in class AbstractEventDispatcher

dispatch

public void dispatch(AccessRightsEvent ev,
                     AccessRightsListener arl)

Specified by:

dispatch in interface EventDispatcher

Overrides:

dispatch in class AbstractEventDispatcher

dispatch

public void dispatch(MonitorEvent ev,
                     MonitorListener ml)

Specified by:

dispatch in interface EventDispatcher

Overrides:

dispatch in class AbstractEventDispatcher

dispatch

public void dispatch(GetEvent ev,
                     GetListener gl)

Specified by:

dispatch in interface EventDispatcher

Overrides:

dispatch in class AbstractEventDispatcher

dispatch

public void dispatch(PutEvent ev,
                     PutListener pl)

Specified by:

dispatch in interface EventDispatcher

Overrides:

dispatch in class AbstractEventDispatcher