org.apache.commons.jcs.engine

Class CacheEventQueue<K,V>

java.lang.Object

org.apache.commons.jcs.engine.AbstractCacheEventQueue<K,V>

org.apache.commons.jcs.engine.CacheEventQueue<K,V>

All Implemented Interfaces:

ICacheEventQueue<K,V>

public class CacheEventQueue<K,V>
extends AbstractCacheEventQueue<K,V>

An event queue is used to propagate ordered cache events to one and only one target listener.

This is a modified version of the experimental version. It should lazy initialize the processor thread, and kill the thread if the queue goes empty for a specified period, now set to 1 minute. If something comes in after that a new processor thread should be created.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CacheEventQueue.QProcessor This is the thread that works the queue.

Nested classes/interfaces inherited from class org.apache.commons.jcs.engine.AbstractCacheEventQueue

AbstractCacheEventQueue.AbstractCacheEvent, AbstractCacheEventQueue.DisposeEvent, AbstractCacheEventQueue.PutEvent, AbstractCacheEventQueue.RemoveAllEvent, AbstractCacheEventQueue.RemoveEvent

Nested classes/interfaces inherited from interface org.apache.commons.jcs.engine.behavior.ICacheEventQueue

ICacheEventQueue.QueueType

Field Summary

Fields inherited from class org.apache.commons.jcs.engine.AbstractCacheEventQueue

DEFAULT_WAIT_TO_DIE_MILLIS

Constructor Summary

Constructors

Constructor and Description
CacheEventQueue(ICacheListener<K,V> listener, long listenerId, String cacheName) Constructs with the specified listener and the cache name.
CacheEventQueue(ICacheListener<K,V> listener, long listenerId, String cacheName, int maxFailure, int waitBeforeRetry) Constructor for the CacheEventQueue object

Method Summary

Modifier and Type	Method and Description
void	destroy() Event Q is empty.
ICacheEventQueue.QueueType	getQueueType() What type of queue is this.
IStats	getStatistics() This method returns semi-structured data on this queue.
boolean	isEmpty() Are there elements in the queue.
protected void	put(AbstractCacheEventQueue.AbstractCacheEvent event) Adds an event to the queue.
int	size() Returns the number of elements in the queue.
protected void	stopProcessing() Kill the processor thread and indicate that the queue is destroyed and no longer alive, but it can still be working.

Methods inherited from class org.apache.commons.jcs.engine.AbstractCacheEventQueue

addDisposeEvent, addPutEvent, addRemoveAllEvent, addRemoveEvent, getCacheName, getListenerId, getWaitToDieMillis, initialize, isAlive, isWorking, setAlive, setWaitToDieMillis, setWorking, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheEventQueue

public CacheEventQueue(ICacheListener<K,V> listener,
                       long listenerId,
                       String cacheName)

Constructs with the specified listener and the cache name.

Parameters:

listener -

listenerId -

cacheName -

CacheEventQueue

public CacheEventQueue(ICacheListener<K,V> listener,
                       long listenerId,
                       String cacheName,
                       int maxFailure,
                       int waitBeforeRetry)

Constructor for the CacheEventQueue object

Parameters:

listener -

listenerId -

cacheName -

maxFailure -

waitBeforeRetry -

Method Detail

getQueueType

public ICacheEventQueue.QueueType getQueueType()

What type of queue is this.

Returns:

queueType

stopProcessing

protected void stopProcessing()

Kill the processor thread and indicate that the queue is destroyed and no longer alive, but it can still be working.

destroy

public void destroy()

Event Q is empty.

Calling destroy interrupts the processor thread.

put

protected void put(AbstractCacheEventQueue.AbstractCacheEvent event)

Adds an event to the queue.

Specified by:

put in class AbstractCacheEventQueue<K,V>

Parameters:

event -

getStatistics

public IStats getStatistics()

This method returns semi-structured data on this queue.

Returns:

information on the status and history of the queue

See Also:

ICacheEventQueue.getStatistics()

isEmpty

public boolean isEmpty()

Description copied from interface: ICacheEventQueue

Are there elements in the queue.

Returns:

whether there are any items in the queue.

size

public int size()

Returns the number of elements in the queue.

Returns:

number of items in the queue.