io.sarl.sre

Class Kernel

java.lang.Object

io.sarl.sre.Kernel

@Singleton
public class Kernel
extends Object

This class represents the Kernel of the SRE platform.

The Kernel is a singleton.

The Kernel is assimilated to an agent that is omniscient and distributed other the network. It is containing all the other agents.

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Sebastian Rodriguez, Nicolas Gaud, Stéphane Galland

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Kernel.AsynchronousKernelStoppingListener Asynchronous listener on platform events.

Constructor Summary

Constructors

Constructor and Description
Kernel(serviceManager : javax.inject.Provider<IServiceManager>, exceptionHandler : javax.inject.Provider<Thread.UncaughtExceptionHandler>, configuration : javax.inject.Provider<SreConfig>, factories : javax.inject.Provider<Factories>) Constructs a SRE kernel.

Method Summary

Modifier and Type	Method and Description
protected Kernel.AsynchronousKernelStoppingListener	createKernelListener() Create an instance of the kernel event listener.
SreConfig	getConfiguration()
Logger	getLogger() Replies the logger used by the kernel.
AgentContext	getRootContext() Replies the SRE context of the kernel.
<S extends com.google.common.util.concurrent.Service> S	getService(type : Class<S>) Replies a kernel service that is alive.
boolean	isRunning() Replies if the kernel is running or not.
void	shutdown([timeout : int]) Shutdown the kernel.
void	spawn(agent : Class<? extends Agent>, arguments : Object*) Spawn an agent of the given type, and pass the parameters to its initialization function.
void	spawn(nbAgents : int, agent : Class<? extends Agent>, params : Object*) Spawn agents of the given type, and pass the parameters to its initialization function.
void	spawn(agentID : UUID, agent : Class<? extends Agent>, params : Object*) Spawn an agent of the given type, and pass the parameters to its initialization function.

Methods inherited from class java.lang.Object

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

Constructor Detail

Kernel

@Inject
public new(serviceManager : javax.inject.Provider<IServiceManager>,
                   exceptionHandler : javax.inject.Provider<Thread.UncaughtExceptionHandler>,
                   configuration : javax.inject.Provider<SreConfig>,
                   factories : javax.inject.Provider<Factories>)

Constructs a SRE kernel.

Parameters:

serviceManager - is the instance of the service manager that must be used by the kernel. The service manager must already have registered services inside itself.

exceptionHandler - is the handler of the uncaught exceptions.

configuration - is the provider of SRE configuration.

factories - is the provider of the factories tool.

Method Detail

createKernelListener

@Pure
protected def createKernelListener() : Kernel.AsynchronousKernelStoppingListener 

Description copied from class: Kernel

Create an instance of the kernel event listener.

Returns:

the listener instance.

Since:

0.8.0

isRunning

@Pure
public def isRunning() : boolean 

Description copied from class: Kernel

Replies if the kernel is running or not.

The kernel is running if at least one agent is alive.

Returns:

true if the kernel is running; false otherwise.

getLogger

@Pure
public def getLogger() : Logger 

Description copied from class: Kernel

Replies the logger used by the kernel.

This function replies the logger of the logging service. If this service is down, null is replied.

Returns:

the logger of the kernel.

spawn

public def spawn(agent : Class<? extends Agent>,
                 arguments : Object*) : void 

Description copied from class: Kernel

Spawn an agent of the given type, and pass the parameters to its initialization function.

Parameters:

agent - the type of the agent to spawn.

arguments - the list of the parameters to pass to the agent initialization function.

spawn

public def spawn(nbAgents : int,
                 agent : Class<? extends Agent>,
                 params : Object*) : void 

Description copied from class: Kernel

Spawn agents of the given type, and pass the parameters to its initialization function.

Parameters:

nbAgents - the number of agents to spawn.

agent - the type of the agents to spawn.

params - the list of the parameters to pass to the agent initialization function.

spawn

public def spawn(agentID : UUID,
                 agent : Class<? extends Agent>,
                 params : Object*) : void 

Description copied from class: Kernel

Spawn an agent of the given type, and pass the parameters to its initialization function.

Parameters:

agentID - the identifier of the agent to spawn. If null the identifier is randomly selected.

agent - the type of the agent to spawn.

params - the list of the parameters to pass to the agent initialization function.

getService

@Pure
public def getService(type : Class<S>) : S  with <S extends com.google.common.util.concurrent.Service> 

Description copied from class: Kernel

Replies a kernel service that is alive.

Type Parameters:

S - - type of the type to reply.

Parameters:

type - type of the type to reply.

Returns:

the service, or null.

getRootContext

@Pure
public def getRootContext() : AgentContext 

Description copied from class: Kernel

Replies the SRE context of the kernel.

Returns:

the context for the kernel.

shutdown

public def shutdown([timeout : int]) : void 

Description copied from class: Kernel

Shutdown the kernel.

Parameters:

timeout - the maximum amount of milliseconds to wait for the shutdown. If the provided value is strictly positive, it is the number of milliseconds to wait for the termination of the shutdown. If the provided value is equal to 0, the function returns as soon as the shutdown process is launch (no waiting for the termination of the shutdown). If the value is strictly negative, the function waits forever for the termination of the shutdown process. The default value is -1.

Since:

0.10

getConfiguration

@Pure
public def getConfiguration() : SreConfig