org.openksavi.sponge.core.engine.event

Class BaseEventScheduler

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.engine.event.BaseEventScheduler

All Implemented Interfaces:

EngineModule, EventScheduler, Descriptive, HasEngine, Manageable

Direct Known Subclasses:

QuartzEventScheduler

public abstract class BaseEventScheduler
extends BaseEngineModule
implements EventScheduler

A base event scheduler.

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicLong	currentEntryId Current event scheduler entry id.
protected EventIdGenerator	eventIdGenerator Event ID generator.
protected EventQueue	outQueue Out event queue to which events will be inserted.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseEventScheduler(SpongeEngine engine, EventQueue outQueue) Creates a new event scheduler.

Method Summary

Modifier and Type	Method and Description
EventIdGenerator	getEventIdGenerator()
protected String	getNextEntryId()
void	scheduleNow(Event event) Schedules a specified event now (inserts to the queue immediately).
void	setEventIdGenerator(EventIdGenerator eventIdGenerator)
protected void	validateEvent(Event event)

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

doShutdown, doStartup, getDescription, getEngine, getInternalService, getLabel, getName, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setDescription, setEngine, setLabel, 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.EventScheduler

getEntries, remove, scheduleAfter, scheduleAfter, scheduleAt, scheduleAt, scheduleAt

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

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

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

getDescription, getLabel, getName, setDescription, setLabel, setName

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

getEngine, setEngine

Field Detail

currentEntryId

protected AtomicLong currentEntryId

Current event scheduler entry id.

outQueue

protected EventQueue outQueue

Out event queue to which events will be inserted.

eventIdGenerator

protected EventIdGenerator eventIdGenerator

Event ID generator.

Constructor Detail

BaseEventScheduler

protected BaseEventScheduler(SpongeEngine engine,
                             EventQueue outQueue)

Creates a new event scheduler.

Parameters:

engine - the engine.

outQueue - an output event queue.

Method Detail

scheduleNow

public void scheduleNow(Event event)

Schedules a specified event now (inserts to the queue immediately).

Specified by:

scheduleNow in interface EventScheduler

Parameters:

event - event.

getNextEntryId

protected String getNextEntryId()

getEventIdGenerator

public EventIdGenerator getEventIdGenerator()

setEventIdGenerator

public void setEventIdGenerator(EventIdGenerator eventIdGenerator)

Specified by:

setEventIdGenerator in interface EventScheduler

validateEvent

protected void validateEvent(Event event)