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

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

Author: david.lloyd at jboss.com
Date: 2009-04-30 19:22:16 -0400 (Thu, 30 Apr 2009)
New Revision: 5104

Modified:
   remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/spi/ConnectionProvider.java
Log:
Javadoc

Modified: remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/spi/ConnectionProvider.java
===================================================================
--- remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/spi/ConnectionProvider.java	2009-04-30 23:20:27 UTC (rev 5103)
+++ remoting3/trunk/jboss-remoting/src/main/java/org/jboss/remoting3/spi/ConnectionProvider.java	2009-04-30 23:22:16 UTC (rev 5104)
@@ -30,5 +30,15 @@
  * @remoting.implement
  */
 public interface ConnectionProvider {
+
+    /**
+     * Open an outbound connection to the given URI.  This method is expected to be non-blocking, with the result
+     * stored in the result variable possibly asynchronously.
+     *
+     * @param uri the URI to connect to
+     * @param result the result which should receive the connection
+     * @return a handle which may be used to cancel the connect attempt
+     * @throws IllegalArgumentException if the URI is not valid
+     */
     Cancellable connect(URI uri, Result<ConnectionHandlerFactory> result) throws IllegalArgumentException;
 }