org.openksavi.sponge.core.engine.event

Class SynchroEventQueue

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

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

org.openksavi.sponge.core.engine.event.SynchroEventQueue

All Implemented Interfaces:

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

public class SynchroEventQueue
extends BaseEventQueue

A queue that blocks put operation when a queue is full.

Field Summary

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

capacity

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this event queue.
void	doStartup() Starts up this managed entity.
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, 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

Constructor Detail

SynchroEventQueue

public SynchroEventQueue(String name)

Creates a new priority event queue.

Parameters:

name - queue name.

Method Detail

doStartup

public void doStartup()

Starts up this managed entity.

Overrides:

doStartup in class BaseEngineModule

put

public void put(org.openksavi.sponge.event.Event event)

Puts a new event into the event queue. Blocks if there is no capacity.

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.