/interpreter/tags/at2dist091109/src/edu/vub/at/actors/ATLetter.java

 1package edu.vub.at.actors;
 2
 3import edu.vub.at.exceptions.InterpreterException;
 4import edu.vub.at.objects.ATObject;
 5
 6/**
 7 * ATLetter is the public interface to an AmbientTalk letter. The inbox of
 8 * and actor consists of a set of objects that implement this interface.
 9 * @author stimberm
10 */
11public interface ATLetter extends ATObject {
12	
13	/**
14	 * Returns the receiver of the letter
15	 * @return the receiver of the letter
16	 */
17	public ATObject base_receiver() throws InterpreterException;
18	
19	/**
20	 * Returns the message that is contained in the letter and
21	 * that should be delivered to the receiver.
22	 * @return an {@link ATAsyncMessage} denoting the message
23	 */
24	public ATAsyncMessage base_message() throws InterpreterException;
25	
26	/**
27	 * Cancels the delivery of this letter. It is immediately removed
28	 * from the actor's inbox.
29	 */
30	public ATObject base_cancel() throws InterpreterException;
31
32}