io.sarl.sre.spaces

Class OpenLocalEventSpace

java.lang.Object

io.sarl.lang.core.SRESpecificDataContainer

io.sarl.sre.spaces.AbstractSpace

io.sarl.sre.spaces.AbstractEventSpace

io.sarl.sre.spaces.OpenLocalEventSpace

All Implemented Interfaces:

OpenEventSpace, EventSpace, Space, SpaceWithParticipants

public class OpenLocalEventSpace
extends AbstractEventSpace
implements OpenEventSpace

Default implementation of an event space which has a local repository.

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

Method Summary

Modifier and Type	Method and Description
Address	register(entity : EventListener, [weakParticipant : boolean]) Deprecated.
Address	registerStrongParticipant(entity : EventListener) Registers the strong participant inside this space.
Address	registerWeakParticipant(entity : EventListener) Registers the weak participant inside this space.
Address	unregister(entity : EventListener) Unregisters the entity inside this space.

Methods inherited from class io.sarl.sre.spaces.AbstractEventSpace

emit, emitLocally, ensureEventSource, forEachStrongParticipant, forEachStrongParticipant, forEachWeakParticipant, forEachWeakParticipant, getAddress, getEventTransportService, getListenerFromStrongParticipant, getLogger, getNumberOfStrongParticipants, getNumberOfWeakParticipants, getScopedParticipants, getSpaceParticipantListener, isPseudoEmpty, registerToSpace, setEventTransportService, unregisterFromSpace

Methods inherited from class io.sarl.sre.spaces.AbstractSpace

fireDestroyableSpace, getSpaceID, setSpaceListenerIfNone, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.sarl.lang.core.EventSpace

emit, emit, getAddress

Methods inherited from interface io.sarl.lang.core.Space

forEachStrongParticipant, forEachWeakParticipant, getNumberOfStrongParticipants, getNumberOfWeakParticipants, getSpaceID, isPseudoEmpty, isPseudoEmpty

Methods inherited from interface io.sarl.lang.core.EventSpace

emit

Methods inherited from interface io.sarl.lang.core.Space

getSpaceID, isPseudoEmpty

Methods inherited from interface io.sarl.lang.core.Space

getSpaceID, isPseudoEmpty

Methods inherited from interface io.sarl.lang.core.Space

isPseudoEmpty

Method Detail

register

@Deprecated
public def register(entity : EventListener,
                                [weakParticipant : boolean]) : Address 

Deprecated.

Description copied from interface: OpenEventSpace

Registers the participant inside this space. After registering a new participant, the Space should emit a ParticipantJoined event where the source is the address of the newly registered agent.

If the agent is already registered the address is return, but the listener is not replaced.

Specified by:

register in interface OpenEventSpace

Parameters:

entity - the participant to register.

Returns:

the entity's address in this space

registerStrongParticipant

public def registerStrongParticipant(entity : EventListener) : Address 

Description copied from interface: OpenEventSpace

Registers the strong participant inside this space. A Weak participant will not prevent the space from begin destroyed if it is the only one staying in it, a Strong participant will prevent the space destruction. A space containing only Weak participants will be destroyed by the SRE Kernel. After registering a new participant, the Space should emit a ParticipantJoined event where the source is the address of the newly registered agent.

If the agent is already registered the address is return, but the listener is not replaced.

Specified by:

registerStrongParticipant in interface OpenEventSpace

Parameters:

entity - the participant to register.

Returns:

the entity's address in this space

registerWeakParticipant

public def registerWeakParticipant(entity : EventListener) : Address 

Description copied from interface: OpenEventSpace

Registers the weak participant inside this space. A Weak participant will not prevent the space from begin destroyed if it is the only one staying in it, a Strong participant will prevent the space destruction. A space containing only Weak participants will be destroyed by the SRE Kernel. After registering a new participant, the Space should emit a ParticipantJoined event where the source is the address of the newly registered agent.

If the agent is already registered the address is return, but the listener is not replaced.

Specified by:

registerWeakParticipant in interface OpenEventSpace

Parameters:

entity - the participant to register.

Returns:

the entity's address in this space

unregister

public def unregister(entity : EventListener) : Address 

Description copied from interface: OpenEventSpace

Unregisters the entity inside this space. After unregistering an agent, the Space should emit a ParticipantLeft event where the source is the address of the unregistered agent.

Specified by:

unregister in interface OpenEventSpace

Parameters:

entity - the participant to unregister.

Returns:

the former entity's address