[jboss-remoting-commits] JBoss Remoting SVN: r4988 - remoting2/branches/2.2/src/main/org/jboss/remoting.

[jboss-remoting-commits at lists.jboss.org]

Author: ron.sigal at jboss.com
Date: 2009-04-14 01:58:18 -0400 (Tue, 14 Apr 2009)
New Revision: 4988

Modified:
   remoting2/branches/2.2/src/main/org/jboss/remoting/Client.java
Log:
JBREM-1103: Updated javadoc for invokeOneway() methods.

Modified: remoting2/branches/2.2/src/main/org/jboss/remoting/Client.java
===================================================================
--- remoting2/branches/2.2/src/main/org/jboss/remoting/Client.java	2009-04-14 05:01:03 UTC (rev 4987)
+++ remoting2/branches/2.2/src/main/org/jboss/remoting/Client.java	2009-04-14 05:58:18 UTC (rev 4988)
@@ -566,17 +566,18 @@
     * client will not wait for a return.
     * <b>
     * This is done one of two ways. The first is to pass true as the clientSide param.  This will
-    * cause the execution of the remote call to be excuted in a new thread on the client side and
+    * cause the execution of the remote call to be executed in a new thread on the client side and
     * will return the calling thread before making call to server side.  Although, this is optimal
     * for performance, will not know about any problems contacting server.
     * <p/>
     * The second, is to pass false as the clientSide param. This will allow the current calling
     * thread to make the call to the remote server, at which point, the server side processing of
     * the thread will be executed on the remote server in a new executing thread and the client
-    * thread will return.  This is a little slower, but will know that the call made it to the
-    * server.
-    *
-    * NOTE:  false case is not accurate.
+    * thread will return.
+    * <p>
+    * NOTE:  The treatment of server side oneway invocations may vary with the transport.  The
+    * client side transport is not required to wait for a reply from the server.  In particular,
+    * the socket and bisocket transports return immediately after writing the invocation.
     */
    public void invokeOneway(final Object param, final Map sendPayload, boolean clientSide)
       throws Throwable
@@ -780,8 +781,7 @@
 
    /**
     * Same as calling invokeOneway(Object param, Map sendPayload, boolean clientSide) with
-    * clientSide param being false and a null sendPayload. Therefore, client thread will not return
-    * till it has made remote call.
+    * clientSide param being false and a null sendPayload.
     */
    public void invokeOneway(Object param) throws Throwable
    {
@@ -790,8 +790,7 @@
 
    /**
     * Same as calling invokeOneway(Object param, Map sendPayload, boolean clientSide) with
-    * clientSide param being false.  Therefore, client thread will not return till it has made
-    * remote call.
+    * clientSide param being false.
     */
    public void invokeOneway(Object param, Map sendPayload) throws Throwable
    {