Updated javadoc.

rxin · rxin · commit ad4241ad8e6f · 2014-12-05T19:19:17.000-08:00
diff --git a/network/common/src/main/java/org/apache/spark/network/client/TransportClientFactory.java b/network/common/src/main/java/org/apache/spark/network/client/TransportClientFactory.java
@@ -107,10 +107,14 @@ public TransportClientFactory(
   }
 
   /**
-   * Create a new {@link TransportClient} connecting to the given remote host / port. This will
-   * reuse TransportClients if they are still active and are for the same remote address. Prior
-   * to the creation of a new TransportClient, we will execute all {@link TransportClientBootstrap}s
-   * that are registered with this factory.
+   * Create a {@link TransportClient} connecting to the given remote host / port.
+   *
+   * We maintains an array of clients (size determined by spark.shuffle.io.numConnectionsPerPeer)
+   * and randomly picks one to use. If no client was previously created in the randomly selected
+   * spot, this function creates a new client and places it there.
+   *
+   * Prior to the creation of a new TransportClient, we will execute all
+   * {@link TransportClientBootstrap}s that are registered with this factory.
    *
    * This blocks until a connection is successfully established and fully bootstrapped.
    *

Original file line number	Diff line number	Diff line change
`@@ -107,10 +107,14 @@ public TransportClientFactory(`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`/**`
`110`		`- * Create a new {@link TransportClient} connecting to the given remote host / port. This will`
`111`		`- * reuse TransportClients if they are still active and are for the same remote address. Prior`
`112`		`- * to the creation of a new TransportClient, we will execute all {@link TransportClientBootstrap}s`
`113`		`- * that are registered with this factory.`
	`110`	`+ * Create a {@link TransportClient} connecting to the given remote host / port.`
	`111`	`+ *`
	`112`	`+ * We maintains an array of clients (size determined by spark.shuffle.io.numConnectionsPerPeer)`
	`113`	`+ * and randomly picks one to use. If no client was previously created in the randomly selected`
	`114`	`+ * spot, this function creates a new client and places it there.`
	`115`	`+ *`
	`116`	`+ * Prior to the creation of a new TransportClient, we will execute all`
	`117`	`+ * {@link TransportClientBootstrap}s that are registered with this factory.`
`114`	`118`	`*`
`115`	`119`	`* This blocks until a connection is successfully established and fully bootstrapped.`
`116`	`120`	`*`