io.sarl.sre.spaces

Class AbstractEventSpace

java.lang.Object

io.sarl.lang.core.SRESpecificDataContainer

io.sarl.sre.spaces.AbstractSpace

io.sarl.sre.spaces.AbstractEventSpace

All Implemented Interfaces:

EventSpace, Space, SpaceWithParticipants

public abstract class AbstractEventSpace
extends AbstractSpace
implements EventSpace, SpaceWithParticipants

Abstract implementation of an event space.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractEventSpace(spaceId : SpaceID, participantListener : SpaceParticipantListener, logger : LoggingService) Constructor.
protected	AbstractEventSpace(spaceId : SpaceID, participantListener : SpaceParticipantListener, loggingService : LoggingService, strongRepository : ConcurrentMap<UUID,Participant>, weakRepository : ConcurrentMap<UUID,Participant>) Constructor.

Method Summary

Modifier and Type	Method and Description
void	emit(eventSource : UUID, event : Event, scope : Scope<Address>) Emits the event inside this space with the given scope.
protected void	emitLocally(event : Event, scope : Scope<? super Address>) Do the emission of the event.
protected void	ensureEventSource(eventSource : UUID, event : Event) Ensure that the given event has a source.
void	forEachStrongParticipant(callback : (UUID)=>void) Apply the given procedure to each of the strong participants.
void	forEachStrongParticipant(callback : (UUID,Participant)=>void) Apply the given procedure to each of the strong participants.
void	forEachWeakParticipant(callback : (UUID)=>void) Apply the given procedure to each of the weak participants.
void	forEachWeakParticipant(callback : (UUID,Participant)=>void) Apply the given procedure to each of the weak participants.
Address	getAddress(id : UUID) Returns the address of the agent identified by id.
EventTransportService	getEventTransportService()
EventListener	getListenerFromStrongParticipant(target : UUID) Replies the event listener with the given identifier into the registered strong participants.
Logger	getLogger()
int	getNumberOfStrongParticipants() Replies the number of strong participants to the space.
int	getNumberOfWeakParticipants() Replies the number of strong participants to the space.
ConcurrentLinkedDeque<Participant>	getScopedParticipants(scope : Scope<? super Address>) Replies the participants that matches the given scope.
SpaceParticipantListener	getSpaceParticipantListener()
boolean	isPseudoEmpty(id : UUID) Replies if the space is empty or the given identifier is associated to the only one participant to the space.
protected Address	registerToSpace(entity : EventListener, weakParticipant : boolean) Register the specified entity on this space
void	setEventTransportService(router : EventTransportService) Set the event router.
protected Address	unregisterFromSpace(entity : EventListener)

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

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

Constructor Detail

AbstractEventSpace

public new(spaceId : SpaceID,
           participantListener : SpaceParticipantListener,
           logger : LoggingService)

Constructor.

Parameters:

id - identifier of the space.

lockProvider - the provider of synchronization locks.

participantListener - the platform listener on participant events.

logger - the logger service.

AbstractEventSpace

protected new(spaceId : SpaceID,
              participantListener : SpaceParticipantListener,
              loggingService : LoggingService,
              strongRepository : ConcurrentMap<UUID,Participant>,
              weakRepository : ConcurrentMap<UUID,Participant>)

Constructor.

Parameters:

id - identifier of the space.

lockProvider - the provider of synchronization locks.

participantListener - the platform listener on participant events.

logger - the logger service.

Method Detail

setEventTransportService

@Inject
public def setEventTransportService(router : EventTransportService) : void 

Description copied from class: AbstractEventSpace

Set the event router.

Parameters:

router - the router.

Since:

0.8

registerToSpace

protected final def registerToSpace(entity : EventListener,
                                    weakParticipant : boolean) : Address 

Description copied from class: AbstractEventSpace

Register the specified entity on this space

Parameters:

entity - - the entity to be registered

weakParticipant - - boolean specifying if the specified entity may prevent the space from the destruction if it is the only remaining entity within 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 it. A space containing only Weak participants will be destroyed by the SRE Kernel

unregisterFromSpace

protected final def unregisterFromSpace(entity : EventListener) : Address 

getAddress

@Pure
public def getAddress(id : UUID) : Address 

Description copied from interface: EventSpace

Returns the address of the agent identified by id.

Specified by:

getAddress in interface EventSpace

Parameters:

id - the agent's id.

Returns:

the agent's address in this space.

emit

public final def emit(eventSource : UUID,
                      event : Event,
                      scope : Scope<Address>) : void 

Description copied from interface: EventSpace

Emits the event inside this space with the given scope. Only agents matching the scope will receive the event.

This function does not change the source of the event if it was set.

If the given event has no specified source, the emit function uses the eventSource parameter to set the source's address.

Specified by:

emit in interface EventSpace

Parameters:

eventSource - the sender of the event.

event - the event to emit in the space.

scope - the definition of the list of receivers of the event.

ensureEventSource

protected def ensureEventSource(eventSource : UUID,
                                event : Event) : void 

Description copied from class: AbstractEventSpace

Ensure that the given event has a source.

Parameters:

eventSource - the source of the event.

event - the event to emit.

Since:

0.6.0

getScopedParticipants

@Pure
public def getScopedParticipants(scope : Scope<? super Address>) : ConcurrentLinkedDeque<Participant> 

Description copied from class: AbstractEventSpace

Replies the participants that matches the given scope.

Parameters:

scope - the scope.

Returns:

the matching participants.

emitLocally

protected def emitLocally(event : Event,
                          scope : Scope<? super Address>) : void 

Description copied from class: AbstractEventSpace

Do the emission of the event.

This function emits the event only on the internal event bus of the listeners.

This function launch a task for each matching listener.

Parameters:

event - the event to emit.

scope - description of the scope of the event, i.e. the receivers of the event.

getNumberOfStrongParticipants

@Pure
public def getNumberOfStrongParticipants() : int 

Description copied from interface: Space

Replies the number of strong participants to the space. This function ignores the weak participants.

Specified by:

getNumberOfStrongParticipants in interface Space

Returns:

the number of participants.

getNumberOfWeakParticipants

@Pure
public def getNumberOfWeakParticipants() : int 

Description copied from interface: Space

Replies the number of strong participants to the space. This function ignores the weak participants.

Specified by:

getNumberOfWeakParticipants in interface Space

Returns:

the number of participants.

isPseudoEmpty

@Pure
public def isPseudoEmpty(id : UUID) : boolean 

Description copied from interface: Space

Replies if the space is empty or the given identifier is associated to the only one participant to the space. Weak participants are ignored by this function.

Specified by:

isPseudoEmpty in interface Space

Parameters:

id - the identifier to test.

Returns:

true if space if empty or the identifier is associated to the only one participant.

forEachStrongParticipant

public def forEachStrongParticipant(callback : (UUID)=>void) : void 

Description copied from interface: Space

Apply the given procedure to each of the strong participants. This function ignores the weak participants.

Specified by:

forEachStrongParticipant in interface Space

Parameters:

callback - the lambda to invoke.

forEachWeakParticipant

public def forEachWeakParticipant(callback : (UUID)=>void) : void 

Description copied from interface: Space

Apply the given procedure to each of the weak participants. This function ignores the strong participants.

Specified by:

forEachWeakParticipant in interface Space

Parameters:

callback - the lambda to invoke.

forEachStrongParticipant

public def forEachStrongParticipant(callback : (UUID,Participant)=>void) : void 

Description copied from interface: SpaceWithParticipants

Apply the given procedure to each of the strong participants. This function ignores the weak participants.

Specified by:

forEachStrongParticipant in interface SpaceWithParticipants

Parameters:

callback - the lambda to invoke.

forEachWeakParticipant

public def forEachWeakParticipant(callback : (UUID,Participant)=>void) : void 

Description copied from interface: SpaceWithParticipants

Apply the given procedure to each of the weak participants. This function ignores the strong participants.

Specified by:

forEachWeakParticipant in interface SpaceWithParticipants

Parameters:

callback - the lambda to invoke.

getListenerFromStrongParticipant

@Pure
public def getListenerFromStrongParticipant(target : UUID) : EventListener 

Description copied from interface: SpaceWithParticipants

Replies the event listener with the given identifier into the registered strong participants.

Specified by:

getListenerFromStrongParticipant in interface SpaceWithParticipants

Parameters:

target - the identifier of the event listener to search for.

Returns:

the event listener or null if there is no event listener found.

getLogger

@Pure
public def getLogger() : Logger 

getEventTransportService

@Pure
public def getEventTransportService() : EventTransportService 

getSpaceParticipantListener

@Pure
public def getSpaceParticipantListener() : SpaceParticipantListener