cz.agents.alite.common.event

Class EventProcessor

java.lang.Object

cz.agents.alite.common.event.EventProcessor

Direct Known Subclasses:

Simulation

public class EventProcessor
extends Object

The event processor is a wrapper for an event-queue cycle. On the fly, the processor lines up events added into it, and "sends" them to their particular recipients in a particular order. By sending, it is meant to call a EventHandler .handleEvent() method, with the event as an argument. An event handler needs to be registered into the processor to receive the events. The event is sent to all event handlers registered with the EventProcessor, if its recipient is null and it is sent to the particular event handler otherwise. The event-queue cycle can be paused/un-paused by the setRunning() method. By the default, the cycle is started running. The time of currently processed events can be obtained by the getCurrentTime() method.

Author:

Antonin Komenda

Field Summary

Fields

Modifier and Type	Field and Description
protected Queue<Event>	eventQueue

Constructor Summary

Constructors

Constructor and Description
EventProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	addEvent(EventHandler eventHandler) Add an immediate event into the queue of the event processor.
void	addEvent(EventHandler eventHandler, long deltaTime) Add an event into the queue of the event processor.
void	addEvent(EventType type, EventHandler recipient, String owner, Object content) Add an immediate event into the queue of the event processor.
void	addEvent(EventType type, EventHandler recipient, String owner, Object content, long deltaTime) Add an event into the queue of the event processor.
void	addEventHandler(EventHandler eventHandler) Adds an EventHandler to list of all event handlers of this processor.
protected void	breforeRunningTest(Event event)
void	clearQueue() Ends the the event processor by clearing the event queue.
protected void	fireEvent(Event event)
protected void	fireEvent(EventType type, EventHandler recipient, String owner, Object content)
int	getCurrentQueueLength() The method can be called from other threads (than the run() method was called).
long	getCurrentTime() The method can be called from other threads (than the run() method was called).
boolean	isFinished() The method can be called from other threads (than the run() method was called).
boolean	isRunning() The method can be called from other threads (than the run() method was called).
void	run()
void	setRunning(boolean running) Method pauses and un-pauses the processing of the events.

Methods inherited from class java.lang.Object

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

Field Detail

eventQueue

protected final Queue<Event> eventQueue

Constructor Detail

EventProcessor

public EventProcessor()

Method Detail

run

public void run()

clearQueue

public void clearQueue()

Ends the the event processor by clearing the event queue. This method has to be called from the same thread as the run() method was called!

addEvent

public void addEvent(EventType type,
            EventHandler recipient,
            String owner,
            Object content)

Add an immediate event into the queue of the event processor. This method has to be called from the same thread as the run() method was called!

Parameters:

type - the type of the event (see EventType)

recipient - the target of the event (use null for all registered event handlers)

owner - a "deprecated" version of the recipient

content - the payload of the event (by the user specified data)

addEvent

public void addEvent(EventType type,
            EventHandler recipient,
            String owner,
            Object content,
            long deltaTime)

Add an event into the queue of the event processor. This method has to be called from the same thread as the run() method was called!

Parameters:

type - the type of the event (see EventType)

recipient - the target of the event (use null for all registered event handlers)

owner - a "deprecated" version of the recipient

content - the payload of the event (by the user specified data)

deltaTime - the duration (in milliseconds) from now till the time when the event should take place (be send to its recipients)

addEvent

public void addEvent(EventHandler eventHandler)

Add an immediate event into the queue of the event processor. represents specific implementation, which handles only one event. This method has to be called from the same thread as the run() method was called!

Parameters:

eventHandler - - through its callback method is informed about end of event.

addEvent

public void addEvent(EventHandler eventHandler,
            long deltaTime)

Add an event into the queue of the event processor. represents specific implementation, which handles only one event. This method has to be called from the same thread as the run() method was called!

Parameters:

eventHandler - - through its callback method is informed about end of event.

deltaTime - the duration (in milliseconds) from now till the time when the event should take place (be send to its recipients)

addEventHandler

public void addEventHandler(EventHandler eventHandler)

Adds an EventHandler to list of all event handlers of this processor. All added handlers, by this method, are used for handling of events without a recipient. The method can be called from other threads (than the run() method was called).

Parameters:

eventHandler -

setRunning

public void setRunning(boolean running)

Method pauses and un-pauses the processing of the events. The method can be called from other threads (than the run() method was called).

Parameters:

running -

isRunning

public boolean isRunning()

The method can be called from other threads (than the run() method was called).

isFinished

public boolean isFinished()

The method can be called from other threads (than the run() method was called).

getCurrentTime

public long getCurrentTime()

The method can be called from other threads (than the run() method was called).

getCurrentQueueLength

public int getCurrentQueueLength()

The method can be called from other threads (than the run() method was called).

breforeRunningTest

protected void breforeRunningTest(Event event)

fireEvent

protected void fireEvent(EventType type,
             EventHandler recipient,
             String owner,
             Object content)

fireEvent

protected void fireEvent(Event event)