ElementEventQueue (Commons JCS 2.0.0-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jcs.engine.control.event
Class ElementEventQueue

java.lang.Object
  org.apache.jcs.engine.control.event.ElementEventQueue

All Implemented Interfaces:: Serializable, IElementEventQueue

public class ElementEventQueue
extends Object
implements IElementEventQueue
extends Object
implements IElementEventQueue

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

See Also:: Serialized Form

Nested Class Summary
`protected class`	`ElementEventQueue.AbstractElementEventRunner` Retries before declaring failure.
`protected static class`	`ElementEventQueue.Node` A node in the queue.

Field Summary
`protected String`	`cacheName` The cache (region) name.
`protected static org.apache.commons.logging.Log`	`log` The logger
`protected Object`	`queueLock` Internal queue implementation

Constructor Summary
`ElementEventQueue(String cacheName)` Constructor for the ElementEventQueue object

Method Summary
`void`	`addElementEvent(IElementEventHandler hand, IElementEvent event)` Adds an ElementEvent to be handled
`void`	`destroy()` Event Q is empty.
`int`	`getWaitToDieMillis()` Returns the time to wait for events before killing the background thread.
`boolean`	`isAlive()` Gets the alive attribute of the IElementEventQueue object
`void`	`setWaitToDieMillis(int wtdm)` Sets the time to wait for events before killing the background thread.
`int`	`size()` Returns the number of elements in the queue.
`void`	`stopProcessing()` Kill the processor thread and indicate that the queue is destroyed and no longer alive, but it can still be working.
`protected ElementEventQueue.AbstractElementEventRunner`	`take()` Returns the next item on the queue, or waits if empty.
`String`	`toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

log

protected static final org.apache.commons.logging.Log log

The logger

cacheName

protected final String cacheName

The cache (region) name.

queueLock

protected final Object queueLock

Internal queue implementation

Constructor Detail

ElementEventQueue

public ElementEventQueue(String cacheName)

Constructor for the ElementEventQueue object

Parameters:: cacheName -

Method Detail

destroy

public void destroy()

Event Q is empty.

Specified by:: destroy in interface IElementEventQueue

stopProcessing

public void stopProcessing()

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

getWaitToDieMillis

public int getWaitToDieMillis()

Returns the time to wait for events before killing the background thread.

Returns:: int

setWaitToDieMillis

public void setWaitToDieMillis(int wtdm)

Sets the time to wait for events before killing the background thread.

Parameters:: wtdm - the ms for the q to sit idle.

toString

public String toString()

Overrides:: toString in class Object

Returns:: the region name for the event queue

size

public int size()

Returns the number of elements in the queue.

Returns:: number of items in the queue.

isAlive

public boolean isAlive()

Description copied from interface: IElementEventQueue

Gets the alive attribute of the IElementEventQueue object

Specified by:: isAlive in interface IElementEventQueue

Returns:: The destroyed value

addElementEvent

public void addElementEvent(IElementEventHandler hand,
                            IElementEvent event)
                     throws IOException

Adds an ElementEvent to be handled

Specified by:: addElementEvent in interface IElementEventQueue

Parameters:: hand - The IElementEventHandler; event - The IElementEventHandler IElementEvent event
Throws:: IOException

take

protected ElementEventQueue.AbstractElementEventRunner take()

Returns the next item on the queue, or waits if empty.

Returns:: AbstractElementEventRunner