io.sarl.core

Interface OpenEventSpace

All Superinterfaces:

EventSpace, Space

All Known Implementing Classes:

OpenLocalEventSpace

public interface OpenEventSpace
extends EventSpace

Event driven interaction space where participants (agents, etc) are free register and unregister themselves. A participant should only register once in this type of space.

A participant is a software entity that is registered in order to receive the events that are emitted into the space. A participant is usually an agent, but not restricted to this type of software entity. It could be also a user-interface module.

A weak participant is participant that could be considered as not a first-order member of the space. When a participant is weak, it is not considered by functions such as #isPseudoEmpty(java.lang.UUID).

Version:

io.sarl.core 0.12.0 20210527-171007

Author:

Sebastian Rodriguez, Stéphane Galland

Maven Group Id:

io.sarl

Maven Artifact Id:

io.sarl.core

Method Summary

Modifier and Type	Method and Description
default Address	register(participant : EventListener, [weakParticipant : boolean]) Deprecated. since 0.12, see OpenEventSpace.registerStrongParticipant(EventListener) and {@link #registerStrongParticipant(EventListener).
Address	registerStrongParticipant(participant : EventListener) Registers the strong participant inside this space.
Address	registerWeakParticipant(participant : EventListener) Registers the weak participant inside this space.
Address	unregister(participant : EventListener) Unregisters the entity inside this space.

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

Method Detail

register

@Deprecated
default def register(participant : EventListener,
                                 [weakParticipant : boolean]) : Address 

Deprecated. since 0.12, see OpenEventSpace.registerStrongParticipant(EventListener) and {@link #registerStrongParticipant(EventListener).

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.

Parameters:

participant - the participant to register.

Returns:

the entity's address in this space

Fired Events:

ParticipantJoined in its enclosing Context default space.

registerStrongParticipant

def registerStrongParticipant(participant : 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.

Parameters:

participant - the participant to register.

Returns:

the entity's address in this space

Since:

0.12

Fired Events:

ParticipantJoined in its enclosing Context default space.

registerWeakParticipant

def registerWeakParticipant(participant : 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.

Parameters:

participant - the participant to register.

Returns:

the entity's address in this space

Since:

0.12

Fired Events:

ParticipantJoined in its enclosing Context default space.

unregister

def unregister(participant : 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.

Parameters:

participant - the participant to unregister.

Returns:

the former entity's address

Fired Events:

ParticipantJoined in its enclosing Context default space.