Modified invocation request procedure to provide a reference to the client

object that initiated the request. Implemented the invocation notification
side of things.


git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@76 542714f4-19e9-0310-aa3c-eee0fc999fb1

src/java/com/threerings/presents/server/InvocationManager.java

@@ -1,5 +1,5 @@
 //
-// $Id: InvocationManager.java,v 1.4 2001/07/19 18:08:20 mdb Exp $
+// $Id: InvocationManager.java,v 1.5 2001/07/19 19:18:07 mdb Exp $
 
 package com.threerings.cocktail.cher.server;
 
@@ -56,6 +56,39 @@ public class InvocationManager
         _providers.put(module, provider);
     }
 
+    /**
+     * Delivers an invocation notification to the specified client. The
+     * <code>module</code> argument selects which
+     * <code>InvocationReceiver</code> will be invoked and the
+     * <code>procedure</code> argument indicates which method will be
+     * invoked on that receiver.
+     *
+     * <p> The method is constructed as follows: a procedure name of
+     * <code>Tell</code> will result in a method call to
+     * <code>handleTellNotification</code>. The arguments provided with
+     * the notification define the necessary signature of that method,
+     * according to the argument conversion rules defined by the
+     * reflection services (<code>Integer</code> is converted to
+     * <code>int</code>, etc.).
+     */
+    public void sendNotification (
+        int cloid, String module, String procedure, Object[] args)
+    {
+        // package up the arguments
+        int alength = (args != null) ? args.length : 0;
+        Object[] nargs = new Object[alength + 2];
+        nargs[0] = module;
+        nargs[1] = procedure;
+        if (args != null) {
+            System.arraycopy(args, 0, nargs, 2, alength);
+        }
+
+        // construct a message event and deliver it
+        MessageEvent nevt = new MessageEvent(
+            cloid, InvocationObject.NOTIFICATION_NAME, nargs);
+        CherServer.omgr.postEvent(nevt);
+    }
+
     public void objectAvailable (DObject object)
     {
         // this must be our invocation object
@@ -82,7 +115,7 @@ public class InvocationManager
 
         // make sure the name is proper just for sanity's sake
         MessageEvent mevt = (MessageEvent)event;
-        if (!mevt.getName().equals(InvocationObject.MESSAGE_NAME)) {
+        if (!mevt.getName().equals(InvocationObject.REQUEST_NAME)) {
             return true;
         }
 
@@ -102,8 +135,17 @@ public class InvocationManager
         }
 
         // prune the method arguments from the full message arguments
-        Object[] margs = new Object[args.length-3];
-        System.arraycopy(args, 3, margs, 0, margs.length);
+        Object[] margs = new Object[args.length-2];
+        int cloid = mevt.getSourceOid();
+        margs[0] = CherServer.omgr.getObject(cloid);
+        // make sure the client is still around
+        if (margs[0] == null) {
+            Log.warning("Client no longer around for invocation provider " +
+                        "request [module=" + module +
+                        ", proc=" + procedure + ", cloid=" + cloid + "].");
+            return true;
+        }
+        System.arraycopy(args, 3, margs, 1, args.length-3);
 
         // look up the method that will handle this procedure
         String mname = "handle" + procedure + "Request";
@@ -131,7 +173,7 @@ public class InvocationManager
             rargs[1] = invid;
             // and create a message event for delivery to the client
             MessageEvent revt = new MessageEvent(
-                mevt.getSourceOid(), InvocationObject.MESSAGE_NAME, rargs);
+                mevt.getSourceOid(), InvocationObject.RESPONSE_NAME, rargs);
             // and ship it off
             CherServer.omgr.postEvent(revt);
         }

src/java/com/threerings/presents/server/InvocationProvider.java

@@ -1,5 +1,5 @@
 //
-// $Id: InvocationProvider.java,v 1.1 2001/07/19 18:08:20 mdb Exp $
+// $Id: InvocationProvider.java,v 1.2 2001/07/19 19:18:07 mdb Exp $
 
 package com.threerings.cocktail.cher.server;
 
@@ -12,9 +12,27 @@ package com.threerings.cocktail.cher.server;
  * procedure identified by the name <code>Tell</code> would result in the
  * invocation of a method named <code>handleTellRequest</code>. The
  * arguments to that method would be defined by the arguments that
- * accompanied the <code>Tell</code> invocation request. If the arguments
- * do not match, a reflection error will happen when trying to invoke the
- * method and the whole request will fail.
+ * accompanied the <code>Tell</code> invocation request along with the
+ * client object of the client that made the request. Specifically:
+ *
+ * <pre>
+ *     // client makes request
+ *     Object[] args = new Object[] { "one", new Integer(2) };
+ *     invmgr.invoke(MODULE, "Test", args, rsptarget);
+ *
+ *     // provider registered for MODULE should look like:
+ *     public class TestProvider extends InvocationProvider
+ *     {
+ *         public Object[] handleTestRequest (ClientObject source,
+ *                                            String one, int two)
+ *         {
+ *             // ...
+ *         }
+ *     }
+ * </pre>
+ *
+ * If the arguments do not match, a reflection error will happen when
+ * trying to invoke the method and the whole request will fail.
  *
  * <p> Invocation procedures must also package up their response in a
  * particular way which is through the use of the

src/java/com/threerings/presents/server/PresentsDObjectMgr.java

@@ -1,5 +1,5 @@
 //
-// $Id: PresentsDObjectMgr.java,v 1.6 2001/06/13 05:17:55 mdb Exp $
+// $Id: PresentsDObjectMgr.java,v 1.7 2001/07/19 19:18:07 mdb Exp $
 
 package com.threerings.cocktail.cher.server;
 
@@ -74,6 +74,20 @@ public class CherDObjectMgr implements DObjectManager
         // nothing to do here, our objects live forever!
     }
 
+    /**
+     * Returns the object in the object table with the specified oid or
+     * null if no object has that oid. Be sure only to call this function
+     * from the dobjmgr thread and not to do anything funny with the
+     * object. If subscription is desired, use
+     * <code>subscribeToObject()</code>.
+     *
+     * @see #subscribeToObject
+     */
+    public DObject getObject (int oid)
+    {
+        return (DObject)_objects.get(oid);
+    }
+
     /**
      * Runs the dobjmgr event loop until it is requested to exit. This
      * should be called from the main application thread.

src/java/com/threerings/presents/server/PresentsServer.java

@@ -1,5 +1,5 @@
 //
-// $Id: PresentsServer.java,v 1.7 2001/07/19 07:48:25 mdb Exp $
+// $Id: PresentsServer.java,v 1.8 2001/07/19 19:18:07 mdb Exp $
 
 package com.threerings.cocktail.cher.server;
 
@@ -28,7 +28,7 @@ public class CherServer
     public static ClientManager clmgr;
 
     /** The distributed object manager. */
-    public static DObjectManager omgr;
+    public static CherDObjectMgr omgr;
 
     /** The invocation manager. */
     public static InvocationManager invmgr;