JanosVM v1.0 API

edu.utah.janosvm.kit.comm.amiga
Class FaxPortHandle

java.lang.Object
  |
  +--edu.utah.janosvm.sys.ListNode
        |
        +--edu.utah.janosvm.sys.Importable
              |
              +--edu.utah.janosvm.kit.comm.amiga.FaxPortHandle
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
FaxPort

public class FaxPortHandle
extends Importable
implements java.lang.Cloneable

A handle for sending faxes to other teams.


Field Summary
protected  FaxPortBackEnd be
          The reference to the back end object.
 
Fields inherited from class edu.utah.janosvm.sys.Importable
em
 
Fields inherited from class edu.utah.janosvm.sys.ListNode
pred, succ
 
Constructor Summary
  FaxPortHandle()
          Construct an empty FaxPortHandle.
(package private) FaxPortHandle(FaxPortHandle fph)
          Construct a copy of the given FaxPortHandle.
  FaxPortHandle(TeamHandle team, java.lang.Object id)
          Construct a FaxPortHandle handle that refers to a specific export in a team.
 
Method Summary
protected  void bindTo(Exportable ex)
          Bind this Importable to the given Exportable.
 FaxPortHandle cloneHandle()
           
 void putFacsimile(Facsimile fax)
          Put a fax on the FaxPortBackEnd's queue.
 java.lang.String toString()
           
protected  void unbindFrom()
          Unbind this Importable from any objects it is referencing.
 
Methods inherited from class edu.utah.janosvm.sys.Importable
copy, finalize, getExportManager, revoke, setExportManager
 
Methods inherited from class edu.utah.janosvm.sys.ListNode
append, clone, inList, prepend, remove
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait, wait0
 

Field Detail

be

protected FaxPortBackEnd be
The reference to the back end object.
Constructor Detail

FaxPortHandle

public FaxPortHandle()
Construct an empty FaxPortHandle.

FaxPortHandle

FaxPortHandle(FaxPortHandle fph)
Construct a copy of the given FaxPortHandle.
Parameters:
fph - The FaxPortHandle to copy.

FaxPortHandle

public FaxPortHandle(TeamHandle team,
                     java.lang.Object id)
              throws DeadTeamException,
                     TeamEjectionException,
                     NoSuchExportException
Construct a FaxPortHandle handle that refers to a specific export in a team.
Parameters:
team - The team to import the FaxPortBackEnd from.
id - The identifier the FaxPortBackEnd is exported under.
Throws:
Throws - NoSuchExportException if the FaxPortBackEnd doesn't exist.
Method Detail

bindTo

protected void bindTo(Exportable ex)
Description copied from class: Importable
Bind this Importable to the given Exportable. The most common implementation of this method would be to cast the Exportable to the type that the Importable subclass handles and store it in the object as well as any other handy pointers/values.

This method will be invoked as a side-effect of binding this importable to an Exportable object via TeamHandle.importObject(edu.utah.janosvm.sys.Importable, java.lang.Object).

XXX Add note about synchronized.

Overrides:
bindTo in class Importable
Following copied from class: edu.utah.janosvm.sys.Importable
Parameters:
ex - The Exportable that is being imported.

unbindFrom

protected void unbindFrom()
Description copied from class: Importable
Unbind this Importable from any objects it is referencing. The most common implementation of this method would be null out any object references in this object.

This method will be invoked as a side-effect of canceling this import, or when the Team owning the Exportable is terminated, or when the Exportable is revoked.

XXX rename to just 'unbind'.

Overrides:
unbindFrom in class Importable
Following copied from class: edu.utah.janosvm.sys.Importable
See Also:
TeamHandle.cancelImport(edu.utah.janosvm.sys.Importable), Team.revokeObject(java.lang.Object), TeamHandle.terminate()

putFacsimile

public void putFacsimile(Facsimile fax)
                  throws DeadTeamException,
                         TeamEjectionException
Put a fax on the FaxPortBackEnd's queue. This is done by visiting the team, cloning the Facsimile and then adding that to the queue.
Parameters:
fax - The facsimile to send to the other team.
Throws:
Throws - DeadTeamException if the visit fails.

cloneHandle

public final FaxPortHandle cloneHandle()
Returns:
A clone of the current handle.

toString

public java.lang.String toString()
Overrides:
toString in class Importable

JanosVM v1.0 API

This documentation is Copyright (C) 2000-2003 The University of Utah. All Rights Reserved. See the documentation license for distribution terms and restrictions.
Documentation, software, and mailing lists for the JanosVM can be found at the Janos Project web page: http://www.cs.utah.edu/flux/janos/
Generated on Feb 13, 2003