Added javadocs

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@631721 13f79535-47bb-0310-9956-ffa450edef68
2008-02-27 20:51:28 +00:00 · 2008-02-27 20:51:28 +00:00 · 64abe1e5a2
parent b055442d4b
commit 64abe1e5a2
1 changed files with 7 additions and 0 deletions
--- a/module-client/src/main/java/org/apache/http/conn/MultihomePlainSocketFactory.java
+++ b/module-client/src/main/java/org/apache/http/conn/MultihomePlainSocketFactory.java
@ -43,6 +43,13 @@ import java.util.List;
 import org.apache.http.params.HttpConnectionParams;
 import org.apache.http.params.HttpParams;

+/**
+ * Socket factory that implements a simple multi-home fail-over on connect failure, 
+ * provided the same hostname resolves to multiple {@link InetAddress}es. Please note
+ * the {@link #connectSocket(Socket, String, int, InetAddress, int, HttpParams)}
+ * method cannot be reliably interrupted by closing the socket returned by the
+ * {@link #createSocket()} method.
+ */
 public final class MultihomePlainSocketFactory implements SocketFactory {

    /**