org.apache.commons.jcs3.engine

Class CacheEventQueue<K,V>

java.lang.Object

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

org.apache.commons.jcs3.engine.PooledCacheEventQueue<K,V>

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

All Implemented Interfaces:

ICacheEventQueue<K,V>

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

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

Nested Class Summary

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

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

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

ICacheEventQueue.QueueType

Field Summary

Fields inherited from class org.apache.commons.jcs3.engine.PooledCacheEventQueue

pool, queue

Fields inherited from class org.apache.commons.jcs3.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
ICacheEventQueue.QueueType	getQueueType() What type of queue is this.
protected void	initialize(ICacheListener<K,V> listener, long listenerId, String cacheName, int maxFailure, int waitBeforeRetry, String threadPoolName) Initializes the queue.

Methods inherited from class org.apache.commons.jcs3.engine.PooledCacheEventQueue

destroy, getStatistics, isEmpty, put, size

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

addDisposeEvent, addPutEvent, addRemoveAllEvent, addRemoveEvent, getCacheName, getListenerId, getWaitToDieMillis, initialize, isWorking, 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

initialize

protected void initialize(ICacheListener<K,V> listener,
                          long listenerId,
                          String cacheName,
                          int maxFailure,
                          int waitBeforeRetry,
                          String threadPoolName)

Initializes the queue.

Overrides:

initialize in class PooledCacheEventQueue<K,V>

Parameters:

listener -

listenerId -

cacheName -

maxFailure -

waitBeforeRetry -

threadPoolName -

getQueueType

public ICacheEventQueue.QueueType getQueueType()

What type of queue is this.

Specified by:

getQueueType in interface ICacheEventQueue<K,V>

Overrides:

getQueueType in class PooledCacheEventQueue<K,V>

Returns:

queueType