[jboss-remoting-commits] JBoss Remoting SVN: r5515 - remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3.

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

Author: david.lloyd at jboss.com
Date: 2009-09-17 00:30:56 -0400 (Thu, 17 Sep 2009)
New Revision: 5515

Modified:
   remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/Client.java
Log:
Clarify javadoc

Modified: remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/Client.java
===================================================================
--- remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/Client.java	2009-09-17 03:49:59 UTC (rev 5514)
+++ remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/Client.java	2009-09-17 04:30:56 UTC (rev 5515)
@@ -89,7 +89,7 @@
      * @throws ReplyException if the operation succeeded but the reply cannot be read for some reason
      * @throws IndeterminateOutcomeException if the result of the operation cannot be ascertained
      * @throws ObjectStreamException if marshalling or unmarshalling some part of the request failed
-     * @throws IOException if some I/O error occurred while sending the request
+     * @throws IOException if some other I/O error occurred while sending the request
      */
     O invoke(I request) throws IOException, CancellationException;
 
@@ -98,16 +98,18 @@
      * may use a local policy to assign one or more thread(s) to handle the local end of that stream, or it may
      * fail with an exception (e.g. if this method is called on a client with no threads to handle streaming).
      * <p/>
-     * Returns immediately.  The returned {@code IoFuture} object can be queried at a later time to determine the result
-     * of the operation.  If the operation fails, one of the conditions described on the {@link #invoke(Object) invoke(I)}
-     * method will result.  This condition can be determined by reading the status of the {@code IoFuture} object or
-     * by attempting to read the result.
+     * This method <b>may</b> block until the request is sent; however once the request is sent, the rest of the request
+     * delivery and processing is fully asynchronous.  The returned {@code IoFuture} object can be queried at a later time
+     * to determine the result of the operation.  If the operation fails, one of the conditions described on the
+     * {@link #invoke(Object) invoke(I)} method will result.  This condition can be determined by reading the status of
+     * the {@code IoFuture} object or by attempting to read the result.
      *
      * @param request the request to send
      *
      * @return a future representing the result of the request
      *
-     * @throws IOException if the request could not be sent
+     * @throws ObjectStreamException if marshalling or unmarshalling some part of the request failed
+     * @throws IOException if some other I/O error occurred while sending the request
      */
     IoFuture<? extends O> send(I request) throws IOException;
 }