/interpreter/tags/at2dist041108/src/edu/vub/at/actors/natives/NATLocalFarRef.java

 1/**
 2 * AmbientTalk/2 Project
 3 * NATLocalFarRef.java created on 22-dec-2006 at 11:34:15
 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.natives;
29
30import edu.vub.at.actors.ATAsyncMessage;
31import edu.vub.at.actors.id.ATObjectID;
32import edu.vub.at.exceptions.InterpreterException;
33import edu.vub.at.objects.ATTable;
34import edu.vub.at.objects.ATTypeTag;
35import edu.vub.at.objects.natives.NATTable;
36
37/**
38 * Instances of NATLocalFarRef denote far references to objects 'local' to this address space.
39 * That is, the far object is hosted by a local actor and hence message transmission is not subject
40 * to network routing or partial failure and messages may be immediately scheduled in the inbox of
41 * the recipient object's host actor.
42 *
43 * @author tvcutsem
44 */
45public class NATLocalFarRef extends NATFarReference {
46
47	/** when serializing a far reference, the event loop stays home */
48	private transient final ELActor farObjectHost_;
49	
50	public NATLocalFarRef(ELActor farObjectHost, ATObjectID objectId, ATTypeTag[] types, ELActor myHost) {
51		super(objectId, types, myHost);
52		farObjectHost_ = farObjectHost;
53	}
54
55	protected void transmit(ATAsyncMessage passedMessage) throws InterpreterException {
56		farObjectHost_.event_localAccept(this, new Packet(passedMessage.toString(),
57				                                          NATTable.of(this, passedMessage)));
58	}
59	
60	/**
61	 * The 'outbox' of a far reference to a local actor is always empty.
62	 */
63	public ATTable meta_retractUnsentMessages() throws InterpreterException {
64		return NATTable.EMPTY;
65	}
66	
67	public ELActor getFarHost() {
68		return farObjectHost_;
69	}
70
71}