/interpreter/tags/at2dist110511/src/edu/vub/at/actors/ATFarReference.java

 1/**
 2 * AmbientTalk/2 Project
 3 * ATFarReference.java created on Dec 5, 2006 at 11:19:05 PM
 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.actors.id.ATObjectID;
31import edu.vub.at.exceptions.InterpreterException;
32import edu.vub.at.objects.ATObject;
33import edu.vub.at.objects.ATTable;
34
35/**
36 * ATFarReference is an object reference denoting an object hosted by another actor.
37 *
38 * @author smostinc
39 */
40public interface ATFarReference extends ATObject {
41
42	/**
43	 * Retracts all of the outgoing messages buffered in this far object reference
44	 * by passing them in a table.
45	 *  
46	 * After this method has been invoked, the outgoing message queue of this far
47	 * reference will be empty.
48	 */
49	public ATTable meta_retractUnsentMessages() throws InterpreterException;
50	
51	public ATObjectID impl_getObjectId();
52	
53}