/
EventSpace.java
122 lines (112 loc) · 4 KB
/
EventSpace.java
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*
* $Id$
*
* SARL is an general-purpose agent programming language.
* More details on http://www.sarl.io
*
* Copyright (C) 2014-2017 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.lang.core;
import java.util.UUID;
import org.eclipse.xtext.xbase.lib.Inline;
import org.eclipse.xtext.xbase.lib.Pure;
/**
* Event driven Interaction {@link Space} for agents.
*
* @author $Author: srodriguez$
* @author $Author: sgalland$
* @version $FullVersion$
* @mavengroupid $GroupId$
* @mavenartifactid $ArtifactId$
*/
public interface EventSpace extends Space {
/**
* Returns the address of the agent identified by <code>id</code>.
*
* @param id - the agent's id.
* @return the agent's address in this space.
*/
@Pure
Address getAddress(UUID id);
/**
* Emits the event inside this space with the given scope. Only agents
* matching the scope will receive the event.
*
* <p>This function does not change the source of the event if it was set.
*
* <p>If the given event has no specified source, the caller of the emit function is assumed
* to set the source's address to the address of the "current" agent. The concept of "current"
* agent depends on the capabilities of the run-time platform. Usually, it is the
* agent that is the cause of the emit.
*
* @param event - the event to emit in the space.
* @param scope - the definition of the list of receivers of the event.
* @deprecated see {@link #emit(UUID, Event, Scope)}, since 0.6
*/
@Deprecated
@Inline(value = "emit(null, $1, $2)")
default void emit(Event event, Scope<Address> scope) {
emit(null, event, scope);
}
/**
* Emits the event inside this space. All registered agents will receive the event.
*
* <p>This function does not change the source of the event if it was set.
*
* <p>If the given event has no specified source, the caller of the emit function is assumed
* to set the source's address to the address of the "current" agent. The concept of "current"
* agent depends on the capabilities of the run-time platform. Usually, it is the
* agent that is the cause of the emit.
*
* @param event - the event to emit in the space.
* @deprecated see {@link #emit(UUID, Event)}, since 0.6
*/
@Inline(value = "emit(null, $1, null)")
@Deprecated
default void emit(Event event) {
emit(null, event, null);
}
/**
* Emits the event inside this space with the given scope. Only agents
* matching the scope will receive the event.
*
* <p>This function does not change the source of the event if it was set.
*
* <p>If the given event has no specified source, the emit function uses the
* {@code eventSource} parameter to set the source's address.
*
* @param eventSource - the sender of the event.
* @param event - the event to emit in the space.
* @param scope - the definition of the list of receivers of the event.
* @since 0.6
*/
void emit(UUID eventSource, Event event, Scope<Address> scope);
/**
* Emits the event inside this space. All registered agents will receive the event.
*
* <p>This function does not change the source of the event if it was set.
*
* <p>If the given event has no specified source, the emit function uses the
* {@code eventSource} parameter to set the source's address.
*
* @param eventSource - the sender of the event.
* @param event - the event to emit in the space.
* @since 0.6
*/
@Inline(value = "emit($1, $2, null)")
default void emit(UUID eventSource, Event event) {
emit(eventSource, event, null);
}
}