LifecycleService (SARL Agent Oriented Programming Language 0.12.0 API)

All Superinterfaces:

com.google.common.util.concurrent.Service

All Known Implementing Classes:

AbstractLifecycleService, AbstractLifecycleService, AbstractLifecycleService, InjectionBasedLifecycleService, StandardLifecycleService
```
public interface LifecycleService
extends com.google.common.util.concurrent.Service
```
This service provides the tools to manage the life-cycle of the agents.

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Sebastian Rodriguez, Stéphane Galland

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Nested Class Summary
- Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service
  com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addDynamicSkillProvider(provider : DynamicSkillProvider)` Add a dynamic skill provider that must be used for the agents that are spawned after the call to this function.
`void`	`addKernelAgentLifecycleListener(listener : KernelAgentLifecycleListener)` Add a listener on the changes related to the kernel agent.
`void`	`addLifecycleServiceListener(agentLifecycleListener : LifecycleServiceListener)` Add a listener on the changes in the current state of an agent.
`boolean`	`getSpawnEnable()` Replies if the spawning of agents is enabled or disabled.
`boolean`	`killAgent(agent : Agent, forceKillable : boolean, terminationCause : Object)` Kill the given agent.
`void`	`removeDynamicSkillProvider(provider : DynamicSkillProvider)` Remove a dynamic skill provider that must be not be used any more for the agents that are spawned.
`void`	`removeKernelAgentLifecycleListener(listener : KernelAgentLifecycleListener)` Remove a listener on the changes related to the kernel agent.
`void`	`removeLifecycleServiceListener(agentLifecycleListener : LifecycleServiceListener)` Remove a listener on the changes in the current state of an agent.
`void`	`setSpawnEnable(enable : boolean)` Enable or disable the spawning of agents.
`void`	`spawnAgent(nbAgents : int, spawningAgent : UUID, parent : Context, agentId : UUID, agentClazz : Class<? extends Agent>, params : Object[])` Spawn agents of the given type, and pass the parameters to its initialization function.

Methods inherited from interface com.google.common.util.concurrent.Service
addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

- Method Detail
  - setSpawnEnable
```
def setSpawnEnable(enable : boolean) : void 
```
    Description copied from interface: LifecycleService
    
    Enable or disable the spawning of agents.
    
    Parameters:
    
    enable - indicates if the spawning of agents is enable or disable.
    
    Since:
    
    0.11
  - getSpawnEnable
```
@Pure
def getSpawnEnable() : boolean 
```
    Description copied from interface: LifecycleService
    
    Replies if the spawning of agents is enabled or disabled.
    
    Returns:
    
    the flag that indicates if the spawning of agents is enable or disable.
    
    Since:
    
    0.11
  - spawnAgent
```
def spawnAgent(nbAgents : int,
               spawningAgent : UUID,
               parent : Context,
               agentId : UUID,
               agentClazz : Class<? extends Agent>,
               params : Object[]) : void 
```
    Description copied from interface: LifecycleService
    
    Spawn agents of the given type, and pass the parameters to its initialization function.
    This function is not blocking until all the agents are spawned.
    
    Parameters:
    
    nbAgents - the number of agents to spawn.
    
    spawningAgent - the agent which is spawning, if null, the root agent (Janus kernel) is assumed.
    
    parent - the parent entity that is creating the agents.
    
    agentId - the identifier of the agent to spawn. If null the identifier is randomly selected. If nbAgents is greater than 1, the agent identifier must be null.
    
    agentClazz - the type of the agents to spawn.
    
    callback - function that is invoked when an identifier of spawned agent is known. The number of times this callback is invoked depends on the service's implementation. But, the contract is that is must be called at least one time when one or more agent is spawned.
    
    params - the list of the parameters to pass to the agent initialization function.
  - killAgent
```
def killAgent(agent : Agent,
              forceKillable : boolean,
              terminationCause : Object) : boolean 
```
    Description copied from interface: LifecycleService
    
    Kill the given agent.
    An agent could be killed only if it does not contain sub-agents.
    Because the agent reference is passed to this function, only the objects which have this reference could kill the agent.
    
    Parameters:
    
    agent - the agent to kill.
    
    forceKillable - indicates if the kill of the agent should be tested before killing it. Usually, the agent cannot be killed when it contains other agents. This flag enables or disables to the run of this test. If true, the agent is always assumed to be killable.
    
    terminationCause - is the cause of the termination of the agent. If it is null, the agent does not provide a specific termination cause.
    
    Returns:
    
    true if the agent was killed by this call; false if the agent is unknown or already killed.
    
    Since:
    
    0.12
  - addLifecycleServiceListener
```
def addLifecycleServiceListener(agentLifecycleListener : LifecycleServiceListener) : void 
```
    Description copied from interface: LifecycleService
    
    Add a listener on the changes in the current state of an agent.
    
    Parameters:
    
    agentLifecycleListener - the listener on the any change in the life-cycle of the agent.
  - removeLifecycleServiceListener
```
def removeLifecycleServiceListener(agentLifecycleListener : LifecycleServiceListener) : void 
```
    Description copied from interface: LifecycleService
    
    Remove a listener on the changes in the current state of an agent.
    
    Parameters:
    
    agentLifecycleListener - the listener on the any change in the life-cycle of the agent.
  - addKernelAgentLifecycleListener
```
def addKernelAgentLifecycleListener(listener : KernelAgentLifecycleListener) : void 
```
    Description copied from interface: LifecycleService
    
    Add a listener on the changes related to the kernel agent.
    
    Parameters:
    
    listener - listener on the spawning events in the local kernel.
  - removeKernelAgentLifecycleListener
```
def removeKernelAgentLifecycleListener(listener : KernelAgentLifecycleListener) : void 
```
    Description copied from interface: LifecycleService
    
    Remove a listener on the changes related to the kernel agent.
    
    Parameters:
    
    listener - listener on the spawning events in the local kernel.
  - addDynamicSkillProvider
```
def addDynamicSkillProvider(provider : DynamicSkillProvider) : void 
```
    Description copied from interface: LifecycleService
    
    Add a dynamic skill provider that must be used for the agents that are spawned after the call to this function.
    
    Parameters:
    
    provider - is the provider of skills for newly created agents.
  - removeDynamicSkillProvider
```
def removeDynamicSkillProvider(provider : DynamicSkillProvider) : void 
```
    Description copied from interface: LifecycleService
    
    Remove a dynamic skill provider that must be not be used any more for the agents that are spawned.
    
    Parameters:
    
    provider - is the provider of skills to be removed.

Interface LifecycleService

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

Method Summary

Methods inherited from interface com.google.common.util.concurrent.Service

Method Detail

setSpawnEnable

getSpawnEnable

spawnAgent

killAgent

addLifecycleServiceListener

removeLifecycleServiceListener

addKernelAgentLifecycleListener

removeKernelAgentLifecycleListener

addDynamicSkillProvider

removeDynamicSkillProvider