Source for java.rmi.dgc.DGC

   1: /* --
   2:    Copyright (c) 1996, 1997, 1998, 1999 Free Software Foundation, Inc.
   4: This file is part of GNU Classpath.
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  14: General Public License for more details.
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  38: package java.rmi.dgc;
  40: import java.rmi.Remote;
  41: import java.rmi.RemoteException;
  42: import java.rmi.server.ObjID;
  44: /**
  45:  * The DGC implementation is used for the server side during the distributed
  46:  * garbage collection. This interface contains the two methods: dirty and clean.
  47:  * A dirty call is made when a remote reference is unmarshaled in a client. A
  48:  * corresponding clean call is made by client it no longer uses that remote
  49:  * reference. A reference to a remote object is also automatically released
  50:  * after so called lease period that starts after the dirty call is received. It
  51:  * is the client's responsibility to renew the leases, by making additional
  52:  * dirty calls before such leases expire.
  53:  */
  54: public interface DGC
  55:     extends Remote
  56: {
  57:   /**
  58:    * Mark the given objects referecnes as used on the client side.
  59:    * 
  60:    * @param ids the ids of the used objects.
  61:    * @param sequenceNum the number of the call (used to detect and discard late
  62:    *          calls).
  63:    * @param lease the requested lease
  64:    * @return the granted lease
  65:    */
  66:   Lease dirty(ObjID[] ids, long sequenceNum, Lease lease)
  67:       throws RemoteException;
  69:   /**
  70:    * Mark the given objects as no longer used on the client side.
  71:    * 
  72:    * @param ids the ids of the objects that are no longer used.
  73:    * @param sequenceNum the number of the call (used to detect and discard late
  74:    * @param vmid the VMID of the client.
  75:    * @param strong make the "strong" clean call ("strong" calls are scheduled
  76:    * after the failed dirty calls).
  77:    */
  78:   void clean(ObjID[] ids, long sequenceNum, VMID vmid, boolean strong)
  79:       throws RemoteException;
  80: }