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