org.openksavi.sponge.core.engine.event

Class PriorityEventQueue

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.engine.event.BaseEventQueue

org.openksavi.sponge.core.engine.event.PriorityEventQueue

All Implemented Interfaces:

org.openksavi.sponge.engine.EngineModule, org.openksavi.sponge.engine.event.EventQueue, org.openksavi.sponge.util.Manageable

public class PriorityEventQueue
extends BaseEventQueue

A priority event queue. Event queue may have a limited size. It supports priority of events. Greater value of the priority signifies a more important event.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	QUEUE_INITIAL_CAPACITY

Fields inherited from class org.openksavi.sponge.core.engine.event.BaseEventQueue

capacity

Constructor Summary

Constructors

Constructor and Description
PriorityEventQueue(String name) Creates a new priority event queue.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this event queue.
protected BlockingQueue<org.openksavi.sponge.event.Event>	createBlockingQueue()
org.openksavi.sponge.event.Event	get(long timeout) Returns the first event from the queue.
int	getSize() Returns the current size of the queue.
void	put(org.openksavi.sponge.event.Event event) Puts a new event into the event queue.

Methods inherited from class org.openksavi.sponge.core.engine.event.BaseEventQueue

getCapacity, setCapacity

Methods inherited from class org.openksavi.sponge.core.engine.BaseEngineModule

doShutdown, doStartup, getEngine, getName, getService, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setEngine, setName, shutdown, startup, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openksavi.sponge.engine.event.EventQueue

getName

Methods inherited from interface org.openksavi.sponge.engine.EngineModule

getEngine, setEngine, setName

Methods inherited from interface org.openksavi.sponge.util.Manageable

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated, shutdown, startup

Field Detail

QUEUE_INITIAL_CAPACITY

protected static final int QUEUE_INITIAL_CAPACITY

See Also:

Constant Field Values

Constructor Detail

PriorityEventQueue

public PriorityEventQueue(String name)

Creates a new priority event queue.

Parameters:

name - queue name.

Method Detail

createBlockingQueue

protected BlockingQueue<org.openksavi.sponge.event.Event> createBlockingQueue()

put

public void put(org.openksavi.sponge.event.Event event)
         throws org.openksavi.sponge.engine.QueueFullException

Puts a new event into the event queue.

Parameters:

event - a new event.

Throws:

org.openksavi.sponge.engine.QueueFullException - when the queue is full.

get

public org.openksavi.sponge.event.Event get(long timeout)
                                     throws InterruptedException

Returns the first event from the queue.

Returns:

the first event from the queue.

Throws:

InterruptedException

getSize

public int getSize()

Returns the current size of the queue.

Returns:

the current size of the queue.

clear

public void clear()

Clears this event queue.