/interpreter/tags/reactive-pattern-matching/src/edu/vub/at/actors/ATObservable.java

 1/**
 2 * AmbientTalk/2 Project
 3 * ATObservable.java
 4 * (c) Programming Technology Lab, 2006 - 2007
 5 * Authors: Tom Van Cutsem & Stijn Mostinckx
 6 * 
 7 * Permission is hereby granted, free of charge, to any person
 8 * obtaining a copy of this software and associated documentation
 9 * files (the "Software"), to deal in the Software without
10 * restriction, including without limitation the rights to use,
11 * copy, modify, merge, publish, distribute, sublicense, and/or
12 * sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following
14 * conditions:
15 *
16 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
21 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
22 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
23 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
24 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
25 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26 * OTHER DEALINGS IN THE SOFTWARE.
27 */
28package edu.vub.at.actors;
29
30import edu.vub.at.exceptions.InterpreterException;
31import edu.vub.at.objects.ATClosure;
32import edu.vub.at.objects.ATNil;
33import edu.vub.at.objects.ATObject;
34import edu.vub.at.objects.grammar.ATSymbol;
35import edu.vub.at.objects.natives.NATTable;
36
37/**
38 * ATObservable is the common interface used to create callbacks.
39 *
40 * @author smostinc
41 * @deprecated
42 */
43public interface ATObservable extends ATObject {
44
45	/**
46	 * Installs an observer on this object
47	 * @param event a symbol denoting a potentially interesting event
48	 * @param observer a closure to be triggered when the event is fired
49	 * @return a closure which can be applied to cancel the observer's subscription
50	 */
51	public abstract ATClosure base_upon_do_(ATSymbol event, ATClosure observer);
52
53	/**
54	 * Fires an event with the given arguments. All the provided closures are applied
55	 * ASYNCHRONOUSLY. This implies that exceptions thrown by such a closure will not
56	 * prevent other observers from getting triggered. Moreover, observers are then
57	 * triggered breadth-first as opposed to depth-first as is the case with synchronous
58	 * invocations.
59	 * 
60	 * @param event - the event being fired
61	 * @param arguments - a possibly empty table of arguments to the event
62	 * @return nil
63	 */
64	public abstract ATNil base_fire_withArgs_(ATSymbol event, NATTable arguments) throws InterpreterException;
65
66}