-
Notifications
You must be signed in to change notification settings - Fork 45
/
OpenEventSpace.sarl
76 lines (69 loc) · 3.1 KB
/
OpenEventSpace.sarl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
* $Id$
*
* SARL is an general-purpose agent programming language.
* More details on http://www.sarl.io
*
* Copyright (C) 2014-2020 the original authors or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.sarl.core
import io.sarl.lang.core.Address
import io.sarl.lang.core.EventListener
import io.sarl.lang.core.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.
*
* <p>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.
*
* <p>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 {@link #isPseudoEmpty(java.lang.UUID)}.
*
* @author $Author: srodriguez$
* @author $Author: sgalland$
* @version $FullVersion$
* @mavengroupid $GroupId$
* @mavenartifactid $ArtifactId$
*/
interface OpenEventSpace extends EventSpace {
/**
* 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.
*
* <p>If the agent is already registered the address is return, but the listener is not replaced.
*
* @param participant the participant to register.
* @param weakParticipant indicates to the space that the given participant could be considered as a weak participant.
* 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
* @return the entity's address in this space
* @fires ParticipantJoined in its enclosing Context default space.
* @since 0.11
*/
def register(participant : EventListener, weakParticipant : boolean = true) : Address fires ParticipantJoined
/**
* 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.
*
* @param participant the participant to unregister.
* @return the former entity's address
* @fires ParticipantJoined in its enclosing Context default space.
*/
def unregister(participant : EventListener) : Address fires ParticipantLeft
}