EventBus (SARL Agent Oriented Programming Language 0.12.0-SNAPSHOT API)

```
public class EventBus
extends Object
```
The class in charge of dispatching every single events coming from the outside of this agent (i.e. from a space) or from an agent's behavior.

Version:

0.12.0-SNAPSHOT 2020-06-30 17:45:08

Author:

Nicolas Gaud, Stéphane Galland

Maven Group Id:

io.janusproject

Maven Artifact Id:

io.janusproject.plugin

Constructor Summary

Constructors
Constructor and Description

EventBus(taskSchedulerProvider : Supplier<InternalSchedules>, dispatcher : BehaviorGuardEvaluatorRegistry)
Instantiates a dispatcher.

Constructors
Constructor and Description
`EventBus(taskSchedulerProvider : Supplier<InternalSchedules>, dispatcher : BehaviorGuardEvaluatorRegistry)` Instantiates a dispatcher.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`asyncDispatch(event : Event, [logger : Logger])` Posts an event to all registered `BehaviorGuardEvaluator`.
`protected Collection<Runnable>`	`evaluateGuards(event : Event, behaviorGuardEvaluators : ConcurrentLinkedDeque<BehaviorGuardEvaluator>, logger : Logger)` Evaluate the guard associated to the specified `event` and returns the list of behaviors methods that must be executed.
`protected void`	`executeAsynchronouslyBehaviorMethods(behaviorsMethodsToExecute : Collection<Runnable>)` Execute every single Behaviors runnable, a dedicated thread will created by the executor local to this class and be used to execute each runnable in parallel.
`protected void`	`executeBehaviorMethodsInParalellWithSynchroAtTheEnd(behaviorsMethodsToExecute : Collection<Runnable>, thrownExceptions : boolean, logger : Logger)` Execute every single Behaviors runnable, a dedicated thread will created by the executor local to this class and be used to execute each runnable in parallel, and this method waits until its future has been completed before leaving.
`InternalSchedules`	`getExecutor()` Replies the agent's task scheduler that must be used by the event bus.
`<T> ConcurrentLinkedDeque<T>`	`getRegisteredEventListeners(type : Class<T>)` Extract the registered listeners with the given type.
`boolean`	`hasRegisteredEventListener(type : Class<?>)` Replies if a listener with the given type is registered.
`void`	`immediateDispatch(event : Event, thrownExceptions : boolean, [logger : Logger])` Posts an event to all registered `BehaviorGuardEvaluator`.
`void`	`immediateDispatchTo(listener : Object, event : Event, thrownExceptions : boolean, [logger : Logger])` Posts an event to the registered `BehaviorGuardEvaluator` of the given listener only.
`void`	`register(object : Object, filter : (Event)=>Boolean, callback : (Object)=>void)` Registers all `PerceptGuardEvaluator` methods on `object` to receive events.
`void`	`unregister(type : Class<?>, callback : (Object)=>Boolean)` Unregisters all `PerceptGuardEvaluator` methods on the objects of the given type.
`void`	`unregister(object : Object, callback : (Object)=>void)` Unregisters all `PerceptGuardEvaluator` methods on a registered `object`.
`void`	`unregisterAll(callback : (Object)=>Boolean)` Unregisters all `PerceptGuardEvaluator` methods on all registered objects.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EventBus
```
public new(taskSchedulerProvider : Supplier<InternalSchedules>,
           dispatcher : BehaviorGuardEvaluatorRegistry)
```
    Instantiates a dispatcher.
    
    Parameters:
    
    taskScheduler - a provider of scheduler for the agent tasks that may be invoked on demand.
    
    dispatcher - the event dispatcher.
- Method Detail
  - getExecutor
```
@Pure
public def getExecutor() : InternalSchedules 
```
    Description copied from class: EventBus
    
    Replies the agent's task scheduler that must be used by the event bus.
    
    Returns:
    
    the executor.
    
    Since:
    
    0.11
  - hasRegisteredEventListener
```
@Pure
public def hasRegisteredEventListener(type : Class<?>) : boolean 
```
    Description copied from class: EventBus
    
    Replies if a listener with the given type is registered.
    
    Parameters:
    
    type - the type of listener.
    
    Returns:
    
    true if a listener of the given type is registered.
    
    Since:
    
    0.5.0
  - getRegisteredEventListeners
```
@Pure
public def getRegisteredEventListeners(type : Class<T>) : ConcurrentLinkedDeque<T>  with <T> 
```
    Description copied from class: EventBus
    
    Extract the registered listeners with the given type.
    
    Type Parameters:
    
    T - the type of the listeners.
    
    Parameters:
    
    type - the type of the listeners.
    
    collection - the collection of listeners that is filled by this function.
    
    Returns:
    
    the number of listeners added to the collection.
    
    Since:
    
    0.6.0
  - register
```
public def register(object : Object,
                    filter : (Event)=>Boolean,
                    callback : (Object)=>void) : void 
```
    Description copied from class: EventBus
    
    Registers all PerceptGuardEvaluator methods on object to receive events.
    If the filter is provided, it will be used for determining if the given behavior accepts a specific event. If the filter function replies true for a specific event as argument, the event is fired in the behavior context. If the filter function replies false, the event is not fired in the behavior context.
    
    Parameters:
    
    object - object whose PerceptGuardEvaluator methods should be registered.
    
    filter - the filter function. It could be null.
    
    callback - function which is invoked just after the first registration of the object. It could be null.
  - unregister
```
public def unregister(object : Object,
                      callback : (Object)=>void) : void 
```
    Description copied from class: EventBus
    
    Unregisters all PerceptGuardEvaluator methods on a registered object.
    
    Parameters:
    
    object - object whose PerceptGuardEvaluator methods should be unregistered.
    
    callback - function which is invoked just before the object is unregistered.
    
    Throws:
    
    IllegalArgumentException - if the object was not previously registered.
  - unregister
```
public def unregister(type : Class<?>,
                      callback : (Object)=>Boolean) : void 
```
    Description copied from class: EventBus
    
    Unregisters all PerceptGuardEvaluator methods on the objects of the given type.
    
    Parameters:
    
    type - type of the objects whose PerceptGuardEvaluator methods should be unregistered.
    
    callback - function which is invoked just before the object is unregistered. The callback functions replies true if it should be called on the next removed object. If it replies false, it will be not called anymore.
    
    Throws:
    
    IllegalArgumentException - if the object was not previously registered.
    
    Since:
    
    0.7
  - unregisterAll
```
public def unregisterAll(callback : (Object)=>Boolean) : void 
```
    Description copied from class: EventBus
    
    Unregisters all PerceptGuardEvaluator methods on all registered objects.
    
    Parameters:
    
    callback - function which is invoked just before the object is unregistered. The callback functions replies true if it should be called on the next removed object. If it replies false, it will be not called anymore.
    
    Throws:
    
    IllegalArgumentException - if the object was not previously registered.
  - immediateDispatch
```
public def immediateDispatch(event : Event,
                             thrownExceptions : boolean,
                             [logger : Logger]) : void 
```
    Description copied from class: EventBus
    
    Posts an event to all registered BehaviorGuardEvaluator. The dispatch of the events within the agent is asynchronous. A rendez-vous point is set up in order to wait for all the event handlers to be finished. This method will return successfully after the event has been posted to all BehaviorGuardEvaluator, and regardless of any exceptions thrown by BehaviorGuardEvaluator.
    
    Parameters:
    
    event - an event to dispatch synchronously.
    
    thrownExceptions - indicates if the exceptions in the event handlers should be thrown from this function, or logged out to the agent's log.
    
    logger - the logger to use for notifying the errors.
  - immediateDispatchTo
```
public def immediateDispatchTo(listener : Object,
                               event : Event,
                               thrownExceptions : boolean,
                               [logger : Logger]) : void 
```
    Description copied from class: EventBus
    
    Posts an event to the registered BehaviorGuardEvaluator of the given listener only. The dispatch of this event will be done synchronously. This method will return successfully after the event has been posted to all BehaviorGuardEvaluator, and regardless of any exceptions thrown by BehaviorGuardEvaluator.
    
    Parameters:
    
    listener - the listener to dispatch to.
    
    event - an event to dispatch synchronously.
    
    thrownExceptions - indicates if the exceptions in the event handlers should be thrown from this function, or logged out to the agent's log.
    
    logger - the logger to use for notifying the errors.
  - asyncDispatch
```
public def asyncDispatch(event : Event,
                         [logger : Logger]) : void 
```
    Description copied from class: EventBus
    
    Posts an event to all registered BehaviorGuardEvaluator. The dispatch of this event will be done asynchronously. This method will return successfully after the event has been posted to all BehaviorGuardEvaluator, and regardless of any exceptions thrown by BehaviorGuardEvaluator.
    
    Parameters:
    
    event - an event to dispatch asynchronously.
    
    logger - the logger to use for notifying the errors.
  - evaluateGuards
```
protected def evaluateGuards(event : Event,
                             behaviorGuardEvaluators : ConcurrentLinkedDeque<BehaviorGuardEvaluator>,
                             logger : Logger) : Collection<Runnable> 
```
    Description copied from class: EventBus
    
    Evaluate the guard associated to the specified event and returns the list of behaviors methods that must be executed.
    Errors are logger by the executor service. But they are not stopping the call to this function.
    
    Parameters:
    
    event - the event triggering behaviors.
    
    behaviorGuardEvaluators - the list of class containing a PerceptGuardEvaluator method.
    
    logger - the logger to be used.
    
    Returns:
    
    the collection of couple associating a object and its collection of behavior methods that must be executed.
    
    Throws:
    
    InvocationTargetException - - exception when you try to execute a method by reflection and this method doesn't exist.
  - executeBehaviorMethodsInParalellWithSynchroAtTheEnd
```
protected def executeBehaviorMethodsInParalellWithSynchroAtTheEnd(behaviorsMethodsToExecute : Collection<Runnable>,
                                                                  thrownExceptions : boolean,
                                                                  logger : Logger) : void 
```
    Description copied from class: EventBus
    
    Execute every single Behaviors runnable, a dedicated thread will created by the executor local to this class and be used to execute each runnable in parallel, and this method waits until its future has been completed before leaving.
    Errors are logged by the executor service, and are thrown by this function.
    
    Parameters:
    
    behaviorsMethodsToExecute - the collection of Behaviors runnable that must be executed.
    
    thrownExceptions - indicates if the exceptions in the event handlers should be thrown from this function, or logged out to the agent's log.
    
    logger - the logger to use for notifying the errors.
    
    Throws:
    
    InterruptedException - - something interrupt the waiting of the event handler terminations.
    
    ExecutionException - - when the event handlers cannot be called; or when one of the event handler has failed during its run.
  - executeAsynchronouslyBehaviorMethods
```
protected def executeAsynchronouslyBehaviorMethods(behaviorsMethodsToExecute : Collection<Runnable>) : void 
```
    Description copied from class: EventBus
    
    Execute every single Behaviors runnable, a dedicated thread will created by the executor local to this class and be used to execute each runnable in parallel.
    Errors are logged by the executor service. They are not thrown by this function.
    
    Parameters:
    
    behaviorsMethodsToExecute - the collection of Behaviors runnable that must be executed.

Class EventBus

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventBus

Method Detail

getExecutor

hasRegisteredEventListener

getRegisteredEventListeners

register

unregister

unregister

unregisterAll

immediateDispatch

immediateDispatchTo

asyncDispatch

evaluateGuards

executeBehaviorMethodsInParalellWithSynchroAtTheEnd

executeAsynchronouslyBehaviorMethods