org.openksavi.sponge.engine.event

Interface EventScheduler

All Superinterfaces:

Descriptive, EngineModule, HasEngine, Manageable

public interface EventScheduler
extends EngineModule

Event scheduler.

Method Summary

Modifier and Type	Method and Description
List<EventSchedulerEntry>	getEntries() Returns all scheduled entries.
boolean	remove(EventSchedulerEntry entry) Removes the specified event scheduler entry.
EventSchedulerEntry	scheduleAfter(Event event, long delay) Schedules an event after a specified time.
EventSchedulerEntry	scheduleAfter(Event event, long delay, long interval) Schedules an event after a specified time with the specified interval.
EventSchedulerEntry	scheduleAt(Event event, long at) Schedules an event at a specified time.
EventSchedulerEntry	scheduleAt(Event event, long at, long interval) Schedules an event at a specified time with the specified interval.
EventSchedulerEntry	scheduleAt(Event event, String crontabSpec) Schedules an event in Cron.
void	scheduleNow(Event event) Puts a specified event into the event queue now.
void	setEventIdGenerator(EventIdGenerator eventIdGenerator) Sets an event ID generator.

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

Method Detail

scheduleNow

void scheduleNow(Event event)

Puts a specified event into the event queue now.

Parameters:

event - event.

scheduleAfter

EventSchedulerEntry scheduleAfter(Event event,
                                  long delay)

Schedules an event after a specified time.

Parameters:

event - event.

delay - delay in milliseconds.

Returns:

scheduled event entry.

scheduleAfter

EventSchedulerEntry scheduleAfter(Event event,
                                  long delay,
                                  long interval)

Schedules an event after a specified time with the specified interval.

Parameters:

event - event.

delay - delay in milliseconds.

interval - interval in milliseconds.

Returns:

scheduled event entry.

scheduleAt

EventSchedulerEntry scheduleAt(Event event,
                               long at)

Schedules an event at a specified time.

Parameters:

event - event.

at - time in milliseconds.

Returns:

scheduled event entry.

scheduleAt

EventSchedulerEntry scheduleAt(Event event,
                               long at,
                               long interval)

Schedules an event at a specified time with the specified interval.

Parameters:

event - event.

at - time in milliseconds.

interval - interval in milliseconds.

Returns:

scheduled event entry.

scheduleAt

EventSchedulerEntry scheduleAt(Event event,
                               String crontabSpec)

Schedules an event in Cron.

Parameters:

event - event.

crontabSpec - crontab time specification.

Returns:

cron entry.

remove

boolean remove(EventSchedulerEntry entry)

Removes the specified event scheduler entry.

Parameters:

entry - event scheduler entry.

Returns:

true if the specified event scheduler entry has been scheduled.

getEntries

List<EventSchedulerEntry> getEntries()

Returns all scheduled entries.

Returns:

all scheduled entries.

setEventIdGenerator

void setEventIdGenerator(EventIdGenerator eventIdGenerator)

Sets an event ID generator.

Parameters:

eventIdGenerator - an event ID generator.