ensemble

Class EventServer

java.lang.Object

ensemble.EventServer

All Implemented Interfaces:

Acting, LifeCycle, RouterClient, Sensing

Direct Known Subclasses:

AmbisonicsAudioEventServer, AudioEventServer, DummyEventServer, LM_EnergyEventServer, LM_LifeCycleEventServer, LM_MovementEventServer, LM_SoundEventServer, MessageEventServer, MovementEventServer

public abstract class EventServer
extends java.lang.Object
implements LifeCycle, Sensing, Acting, RouterClient

The Class EventServer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	EventServer.HybridScheduler The Class HybridScheduler.
private class	EventServer.PeriodicScheduler The Class PeriodicScheduler.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,Parameters>	actuators The actuators.
protected VirtualClockHelper	clock The clock.
protected Comm	comm The comm.
private java.lang.String	commType The comm type.
protected java.util.ArrayList<Event>	earlyEvents The early events.
protected EnvironmentAgent	envAgent The env agent.
private java.lang.String	eventExchange The event exchange.
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,Parameters>	eventHandlers The event handlers.
private Constants.ES_STATE	eventServerState The event server state.
private java.lang.String	eventType The event type.
protected long	frameTime The frame time.
protected int	happeningFrame The happening frame.
private java.util.ArrayList<Event>	inputEvents The input events.
private boolean	isBatch The is batch.
private java.util.concurrent.locks.Lock	lock The lock.
protected Actuator	myActuator The my actuator.
protected Sensor	mySensor The my sensor.
private long	nextStateChange The next state change.
private java.util.ArrayList<Event>	outputEvents The output events.
private java.util.concurrent.locks.Lock	outputLock The output lock.
protected Parameters	parameters The parameters.
protected long	period The period.
protected long	periodDeadline The period deadline.
protected long	receiveDeadline The receive deadline.
protected int	receivingFrame The receiving frame.
protected long	sendDeadline The send deadline.
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,Parameters>	sensors The sensors.
protected long	startTime The start time.
protected long	waitTime The wait time.
protected int	workingFrame The working frame.

Constructor Summary

Constructors

Constructor and Description
EventServer()

Method Summary

Methods

Modifier and Type	Method and Description
void	act() Sends automatically all events in the outputEvents queue.
protected void	actuatorDeregistered(java.lang.String agentName, java.lang.String actuatorName) Actuator deregistered.
protected Parameters	actuatorRegistered(java.lang.String agentName, java.lang.String actuatorName, Parameters userParam) Actuator registered.
protected void	addOutputEvent(java.lang.String destAgentName, java.lang.String destCompName, Event evt) Adds a event to a queue to be sent the next time act() is called.
void	addParameter(java.lang.String key, java.lang.String value) Adds the parameter.
void	addParameters(Parameters newParameters) Adds the parameters.
Memory	createMemory(java.lang.String name, Parameters parameters) Creates the memory.
void	deregisterEventHandler(java.lang.String agentName, java.lang.String eventHandlerName, java.lang.String eventHandlerType) Deregister event handler.
boolean	finit() User-implemented finalization method, called by stop().
java.lang.String	getAddress() Returns this component framework address.
java.lang.String	getCommType() Gets the comm type.
java.lang.String	getEventExchange() Gets the event exchange.
java.lang.String	getEventType() Gets the event type.
java.lang.String	getParameter(java.lang.String key) Gets the parameter.
java.lang.String	getParameter(java.lang.String key, java.lang.String defaultValue) Gets the parameter.
Parameters	getParameters() Returns all configured parameters.
boolean	init() User-implemented initialization method, called by start().
boolean	parameterUpdate(java.lang.String name, java.lang.String newValue) User-implement method called when a parameter has been updated.
protected void	process() Método chamado para efetuar algum processamento sobre os eventos recebidos, e enviar eventos em seguida.
protected Event	processAction(Event evt) Método chamado para enviar um evento pelo process().
void	processCommand(Command cmd) An user-implemented method to process a received command.
protected void	processSense(Event evt) Método chamado ao receber um evento.
void	receiveCommand(Command cmd) A framework-implemented method that receives a command sent by the RouterAgent and calls processCommand.
void	registerEventHandler(java.lang.String agentName, java.lang.String eventHandlerName, java.lang.String eventHandlerType, Parameters userParameters) Register event handler.
java.lang.String[]	searchRegisteredEventHandler(java.lang.String agentName, java.lang.String componentName, java.lang.String eventType, java.lang.String ehType) Searches the registered event handlers using filters.
void	sendCommand(Command cmd) A framework-implemented method that sends a command to its destination, via RouterAgent if the recipient is another agent.
protected void	sendEvent(Event evt) Sends a single Event.
void	sense(Event evt) Sense.
protected void	senseEarlyEvents(Event evt) Sense early events.
protected void	sensorDeregistered(java.lang.String agentName, java.lang.String sensorName) Sensor deregistered.
protected Parameters	sensorRegistered(java.lang.String agentName, java.lang.String sensorName, Parameters userParam) Sensor registered.
void	setCommType(java.lang.String commType) Sets the comm type.
void	setEnvAgent(EnvironmentAgent envAgent) Sets the env agent.
void	setEventExchange(long period, long waitTime) Sets the event exchange.
boolean	setEventExchange(long period, long receiveDeadline, long sendDeadline, long waitTime) Sets the event exchange.
void	setEventType(java.lang.String eventType) Sets the event type.
void	setParameters(Parameters parameters) Framework-implemented method that sets system and user parameters.
boolean	start() Called by the system to initalize an EventServer.
boolean	stop() Framework-implemented finalization method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ensemble.LifeCycle

configure

Field Detail

lock

private java.util.concurrent.locks.Lock lock

The lock.

outputLock

private java.util.concurrent.locks.Lock outputLock

The output lock.

parameters

protected Parameters parameters

The parameters.

envAgent

protected EnvironmentAgent envAgent

The env agent.

clock

protected VirtualClockHelper clock

The clock.

eventServerState

private Constants.ES_STATE eventServerState

The event server state.

eventType

private java.lang.String eventType

The event type.

eventExchange

private java.lang.String eventExchange

The event exchange.

commType

private java.lang.String commType

The comm type.

isBatch

private boolean isBatch

The is batch.

period

protected long period

The period.

sendDeadline

protected long sendDeadline

The send deadline.

receiveDeadline

protected long receiveDeadline

The receive deadline.

periodDeadline

protected long periodDeadline

The period deadline.

startTime

protected long startTime

The start time.

frameTime

protected long frameTime

The frame time.

waitTime

protected long waitTime

The wait time.

workingFrame

protected int workingFrame

The working frame.

happeningFrame

protected int happeningFrame

The happening frame.

receivingFrame

protected int receivingFrame

The receiving frame.

nextStateChange

private long nextStateChange

The next state change.

actuators

protected java.util.concurrent.ConcurrentHashMap<java.lang.String,Parameters> actuators

The actuators.

sensors

protected java.util.concurrent.ConcurrentHashMap<java.lang.String,Parameters> sensors

The sensors.

eventHandlers

protected java.util.concurrent.ConcurrentHashMap<java.lang.String,Parameters> eventHandlers

The event handlers.

earlyEvents

protected java.util.ArrayList<Event> earlyEvents

The early events.

comm

protected Comm comm

The comm.

mySensor

protected Sensor mySensor

The my sensor.

myActuator

protected Actuator myActuator

The my actuator.

inputEvents

private java.util.ArrayList<Event> inputEvents

The input events.

outputEvents

private java.util.ArrayList<Event> outputEvents

The output events.

Constructor Detail

EventServer

public EventServer()

Method Detail

start

public final boolean start()

Called by the system to initalize an EventServer. Should not be called by the user!

Specified by:

start in interface LifeCycle

Returns:

true, if successful

stop

public final boolean stop()

Description copied from interface: LifeCycle

Framework-implemented finalization method.

Specified by:

stop in interface LifeCycle

Returns:

true, if successful

addParameter

public final void addParameter(java.lang.String key,
                java.lang.String value)

Adds the parameter.

Parameters:

key - the key

value - the value

addParameters

public final void addParameters(Parameters newParameters)

Adds the parameters.

Parameters:

newParameters - the new parameters

getParameter

public final java.lang.String getParameter(java.lang.String key)

Gets the parameter.

Parameters:

key - the key

Returns:

the parameter

getParameter

public final java.lang.String getParameter(java.lang.String key,
                            java.lang.String defaultValue)

Gets the parameter.

Parameters:

key - the key

defaultValue - the default value

Returns:

the parameter

setParameters

public void setParameters(Parameters parameters)

Description copied from interface: LifeCycle

Framework-implemented method that sets system and user parameters.

Specified by:

setParameters in interface LifeCycle

Parameters:

parameters - a Parameters object with all user and system Parameters for this object

getParameters

public Parameters getParameters()

Description copied from interface: LifeCycle

Returns all configured parameters.

Specified by:

getParameters in interface LifeCycle

Returns:

a Parameters object with system and user parameters

setEnvAgent

public void setEnvAgent(EnvironmentAgent envAgent)

Sets the env agent.

Parameters:

envAgent - the new env agent

setCommType

public void setCommType(java.lang.String commType)

Sets the comm type.

Parameters:

commType - the new comm type

getCommType

public java.lang.String getCommType()

Gets the comm type.

Returns:

the comm type

setEventType

public void setEventType(java.lang.String eventType)

Sets the event type.

Parameters:

eventType - the new event type

getEventType

public java.lang.String getEventType()

Gets the event type.

Returns:

the event type

setEventExchange

public void setEventExchange(long period,
                    long waitTime)

Sets the event exchange.

Parameters:

period - the period

waitTime - the wait time

setEventExchange

public boolean setEventExchange(long period,
                       long receiveDeadline,
                       long sendDeadline,
                       long waitTime)

Sets the event exchange.

Parameters:

period - the period

receiveDeadline - the receive deadline

sendDeadline - the send deadline

waitTime - the wait time

Returns:

true, if successful

getEventExchange

public java.lang.String getEventExchange()

Gets the event exchange.

Returns:

the event exchange

searchRegisteredEventHandler

public java.lang.String[] searchRegisteredEventHandler(java.lang.String agentName,
                                              java.lang.String componentName,
                                              java.lang.String eventType,
                                              java.lang.String ehType)

Searches the registered event handlers using filters.

Parameters:

agentName - the agent name

componentName - the component name

eventType - the event type

ehType - the eh type

Returns:

the string[]

registerEventHandler

public void registerEventHandler(java.lang.String agentName,
                        java.lang.String eventHandlerName,
                        java.lang.String eventHandlerType,
                        Parameters userParameters)

Register event handler.

Parameters:

agentName - the agent name

eventHandlerName - the event handler name

eventHandlerType - the event handler type

userParameters - the user parameters

deregisterEventHandler

public void deregisterEventHandler(java.lang.String agentName,
                          java.lang.String eventHandlerName,
                          java.lang.String eventHandlerType)

Deregister event handler.

Parameters:

agentName - the agent name

eventHandlerName - the event handler name

eventHandlerType - the event handler type

createMemory

public Memory createMemory(java.lang.String name,
                  Parameters parameters)

Creates the memory.

Parameters:

name - the name

parameters - the parameters

Returns:

the memory

senseEarlyEvents

protected void senseEarlyEvents(Event evt)

Sense early events.

Parameters:

evt - the evt

sense

public void sense(Event evt)

Description copied from interface: Sensing

Sense.

Specified by:

sense in interface Sensing

Parameters:

evt - the evt

act

public void act()

Sends automatically all events in the outputEvents queue.

Specified by:

act in interface Acting

sendEvent

protected void sendEvent(Event evt)

Sends a single Event.

Parameters:

evt - the evt

addOutputEvent

protected void addOutputEvent(java.lang.String destAgentName,
                  java.lang.String destCompName,
                  Event evt)

Adds a event to a queue to be sent the next time act() is called. It can be used by a sporadic event server to send differents events for differents recipients at the same time

Parameters:

destAgentName - the dest agent name

destCompName - the dest comp name

evt - the evt

getAddress

public final java.lang.String getAddress()

Description copied from interface: RouterClient

Returns this component framework address.

Specified by:

getAddress in interface RouterClient

Returns:

the component address

receiveCommand

public final void receiveCommand(Command cmd)

Description copied from interface: RouterClient

A framework-implemented method that receives a command sent by the RouterAgent and calls processCommand.

Specified by:

receiveCommand in interface RouterClient

Parameters:

cmd - the cmd

sendCommand

public final void sendCommand(Command cmd)

Description copied from interface: RouterClient

A framework-implemented method that sends a command to its destination, via RouterAgent if the recipient is another agent.

Specified by:

sendCommand in interface RouterClient

Parameters:

cmd - the cmd

init

public boolean init()

Description copied from interface: LifeCycle

User-implemented initialization method, called by start().

Specified by:

init in interface LifeCycle

Returns:

true, if successful

parameterUpdate

public boolean parameterUpdate(java.lang.String name,
                      java.lang.String newValue)

Description copied from interface: LifeCycle

User-implement method called when a parameter has been updated.

Specified by:

parameterUpdate in interface LifeCycle

Parameters:

name - the name

newValue - the new value

Returns:

true, if successful

finit

public boolean finit()

Description copied from interface: LifeCycle

User-implemented finalization method, called by stop().

Specified by:

finit in interface LifeCycle

Returns:

true, if successful

processSense

protected void processSense(Event evt)
                     throws java.lang.Exception

Método chamado ao receber um evento. Deve armazenar os eventos recebidos em uma estrutura de dados, para depois ser processado.

Parameters:

evt - the evt

Throws:

java.lang.Exception - the exception

processAction

protected Event processAction(Event evt)
                       throws java.lang.Exception

Método chamado para enviar um evento pelo process(). No caso de eventos frequentes, é chamado automaticamente quando o sendDeadline é atingindo.

Parameters:

evt - the evt

Returns:

the event

Throws:

java.lang.Exception - the exception

process

protected void process()
                throws java.lang.Exception

Método chamado para efetuar algum processamento sobre os eventos recebidos, e enviar eventos em seguida. No caso de eventos frequentes, é chamado automaticamente quando o receiveDeadline é atingindo.

Throws:

java.lang.Exception - the exception

actuatorRegistered

protected Parameters actuatorRegistered(java.lang.String agentName,
                            java.lang.String actuatorName,
                            Parameters userParam)
                                 throws java.lang.Exception

Actuator registered.

Parameters:

agentName - the agent name

actuatorName - the actuator name

userParam - the user param

Returns:

the parameters

Throws:

java.lang.Exception - the exception

actuatorDeregistered

protected void actuatorDeregistered(java.lang.String agentName,
                        java.lang.String actuatorName)
                             throws java.lang.Exception

Actuator deregistered.

Parameters:

agentName - the agent name

actuatorName - the actuator name

Throws:

java.lang.Exception - the exception

sensorRegistered

protected Parameters sensorRegistered(java.lang.String agentName,
                          java.lang.String sensorName,
                          Parameters userParam)
                               throws java.lang.Exception

Sensor registered.

Parameters:

agentName - the agent name

sensorName - the sensor name

userParam - the user param

Returns:

the parameters

Throws:

java.lang.Exception - the exception

sensorDeregistered

protected void sensorDeregistered(java.lang.String agentName,
                      java.lang.String sensorName)
                           throws java.lang.Exception

Sensor deregistered.

Parameters:

agentName - the agent name

sensorName - the sensor name

Throws:

java.lang.Exception - the exception

processCommand

public void processCommand(Command cmd)

Description copied from interface: RouterClient

An user-implemented method to process a received command.

Specified by:

processCommand in interface RouterClient

Parameters:

cmd - the cmd