org.openksavi.sponge.engine.event

Interface EventQueue

All Superinterfaces:

EngineModule, Manageable

public interface EventQueue
extends EngineModule

Event queue. Event queue may have a limited size.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this event queue.
Event	get(long timeout) Returns the first event from the queue.
int	getCapacity() Returns the capacity of the queue.
String	getName() Returns the name of the event queue.
int	getSize() Returns the size of the queue.
void	put(Event event) Puts a new event into the event queue.
void	setCapacity(int capacity) Sets the capacity of the queue.

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

Method Detail

put

void put(Event event)
  throws QueueFullException

Puts a new event into the event queue.

Parameters:

event - a new event.

Throws:

QueueFullException - when the queue is full.

get

Event get(long timeout)
   throws InterruptedException

Returns the first event from the queue.

Parameters:

timeout - the timeout in milliseconds.

Returns:

the first event from the queue or null when there was none.

Throws:

InterruptedException - if any.

setCapacity

void setCapacity(int capacity)

Sets the capacity of the queue.

Parameters:

capacity - the capacity of the queue.

getCapacity

int getCapacity()

Returns the capacity of the queue.

Returns:

the capacity of the queue.

getSize

int getSize()

Returns the size of the queue.

Returns:

the size of the queue.

getName

String getName()

Returns the name of the event queue.

Specified by:

getName in interface EngineModule

Returns:

the name of the event queue.

clear

void clear()

Clears this event queue.