/interpreter/tags/at_build150307/src/edu/vub/at/actors/ATMailbox.java

 1/**
 2 * AmbientTalk/2 Project
 3 * ATMailbox.java created on Aug 21, 2006
 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 */
28
29package edu.vub.at.actors;
30
31import edu.vub.at.exceptions.InterpreterException;
32import edu.vub.at.objects.ATObject;
33import edu.vub.at.objects.ATTable;
34import edu.vub.at.objects.grammar.ATSymbol;
35
36/**
37 * A mailbox is a special kind of table object used to buffer asynchronous messages
38 */
39public interface ATMailbox extends ATTable {
40
41    public ATSymbol base_getName();
42    
43	public ATObject base_enqueue(ATObject value) throws InterpreterException;
44
45	public ATObject base_dequeue() throws InterpreterException;
46
47	/**
48	 * Clears the content of the mailbox (i.e. mailbox becomes empty)
49	 * and return all current messages in a fresh table, which is no longer
50	 * causally connected to this mailbox.
51	 */
52	public ATTable  base_flush() throws InterpreterException;
53	
54}