You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ol...@apache.org on 2011/11/12 16:55:08 UTC
svn commit: r1201279 - in /httpcomponents/httpcore/trunk:
httpcore-nio/src/main/java/org/apache/http/impl/nio/
httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/
httpcore-nio/src/main/java/org/apache/http/impl/nio/reactor/
httpcore-nio/src/main/...
Author: olegk
Date: Sat Nov 12 15:55:07 2011
New Revision: 1201279
URL: http://svn.apache.org/viewvc?rev=1201279&view=rev
Log:
Javadoc updates
Modified:
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/AbstractIODispatch.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/DefaultNHttpClientConnectionFactory.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/DefaultNHttpServerConnectionFactory.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/NHttpConnectionBase.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/SSLNHttpClientConnectionFactory.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/SSLNHttpServerConnectionFactory.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOConnFactory.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOConnPool.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOPoolEntry.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/reactor/IOReactorConfig.java (contents, props changed)
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/NHttpConnectionFactory.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/EntityAsyncContentProducer.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/HttpAsyncContentProducer.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/NStringEntity.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/pool/NIOConnFactory.java
httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/protocol/HttpAsyncRequestProducer.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicConnFactory.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicConnPool.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicPoolEntry.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/pool/ConnFactory.java
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/AbstractIODispatch.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/AbstractIODispatch.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/AbstractIODispatch.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/AbstractIODispatch.java Sat Nov 12 15:55:07 2011
@@ -40,6 +40,7 @@ import org.apache.http.protocol.Executio
* Abstract {@link IOEventDispatch} implementation that supports both plain (non-encrypted)
* and SSL encrypted HTTP connections.
*
+ * @param <T> the connection type.
* @since 4.2
*/
@Immutable // provided injected dependencies are immutable
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/DefaultNHttpClientConnectionFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/DefaultNHttpClientConnectionFactory.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/DefaultNHttpClientConnectionFactory.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/DefaultNHttpClientConnectionFactory.java Sat Nov 12 15:55:07 2011
@@ -39,7 +39,7 @@ import org.apache.http.params.HttpConnec
import org.apache.http.params.HttpParams;
/**
- * Plain (non-encrypted) {@link NHttpClientConnection} factory.
+ * Factory for plain (non-encrypted), non-blocking {@link NHttpClientConnection}s.
* <p>
* The following parameters can be used to customize the behavior of this
* class:
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/DefaultNHttpServerConnectionFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/DefaultNHttpServerConnectionFactory.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/DefaultNHttpServerConnectionFactory.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/DefaultNHttpServerConnectionFactory.java Sat Nov 12 15:55:07 2011
@@ -39,7 +39,7 @@ import org.apache.http.params.HttpConnec
import org.apache.http.params.HttpParams;
/**
- * Plain (non-encrypted) {@link NHttpServerConnection} factory.
+ * Factory for plain (non-encrypted), non-blocking {@link NHttpServerConnection}s.
* <p>
* The following parameters can be used to customize the behavior of this
* class:
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/NHttpConnectionBase.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/NHttpConnectionBase.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/NHttpConnectionBase.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/NHttpConnectionBase.java Sat Nov 12 15:55:07 2011
@@ -165,6 +165,9 @@ public class NHttpConnectionBase
}
/**
+ * Binds the connection to a different {@link IOSession}. This may be necessary
+ * when the underlying I/O session gets upgraded with SSL/TLS encryption.
+ *
* @since 4.2
*/
protected void bind(final IOSession session) {
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/SSLNHttpClientConnectionFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/SSLNHttpClientConnectionFactory.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/SSLNHttpClientConnectionFactory.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/SSLNHttpClientConnectionFactory.java Sat Nov 12 15:55:07 2011
@@ -44,7 +44,7 @@ import org.apache.http.params.HttpConnec
import org.apache.http.params.HttpParams;
/**
- * SSL encrypted non-blocking {@link NHttpClientConnection} factory.
+ * Factory for SSL encrypted, non-blocking {@link NHttpClientConnection}s.
* <p>
* The following parameters can be used to customize the behavior of this
* class:
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/SSLNHttpServerConnectionFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/SSLNHttpServerConnectionFactory.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/SSLNHttpServerConnectionFactory.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/SSLNHttpServerConnectionFactory.java Sat Nov 12 15:55:07 2011
@@ -44,7 +44,7 @@ import org.apache.http.params.HttpConnec
import org.apache.http.params.HttpParams;
/**
- * SSL encrypted non-blocking {@link NHttpServerConnection} factory.
+ * Factory for SSL encrypted, non-blocking {@link NHttpServerConnection}s.
* <p>
* The following parameters can be used to customize the behavior of this
* class:
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOConnFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOConnFactory.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOConnFactory.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOConnFactory.java Sat Nov 12 15:55:07 2011
@@ -47,7 +47,8 @@ import org.apache.http.params.HttpParams
import org.apache.http.protocol.ExecutionContext;
/**
- * Basic non-blocking {@link NHttpClientConnection} factory.
+ * A basic {@link NIOConnFactory} implementation that creates
+ * {@link NHttpClientConnection} instances given a {@link HttpHost} instance.
* <p>
* The following parameters can be used to customize the behavior of this
* class:
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOConnPool.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOConnPool.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOConnPool.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOConnPool.java Sat Nov 12 15:55:07 2011
@@ -41,9 +41,14 @@ import org.apache.http.nio.pool.NIOConnF
import org.apache.http.nio.reactor.ConnectingIOReactor;
import org.apache.http.params.HttpConnectionParams;
import org.apache.http.params.HttpParams;
+import org.apache.http.pool.ConnPool;
/**
- * Basic non-blocking {@link NHttpClientConnection} pool.
+ * A very basic {@link ConnPool} implementation that represents a pool
+ * of non-blocking {@link NHttpClientConnection} connections identified by
+ * an {@link HttpHost} instance. Please note this pool implementation
+ * does not support complex routes via a proxy cannot differentiate between
+ * direct and proxied connections.
* <p>
* The following parameters can be used to customize the behavior of this
* class:
@@ -56,6 +61,7 @@ import org.apache.http.params.HttpParams
* <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_LINE_LENGTH}</li>
* </ul>
*
+ * @see HttpHost
* @since 4.2
*/
@ThreadSafe
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOPoolEntry.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOPoolEntry.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOPoolEntry.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/pool/BasicNIOPoolEntry.java Sat Nov 12 15:55:07 2011
@@ -34,8 +34,11 @@ import org.apache.http.nio.NHttpClientCo
import org.apache.http.pool.PoolEntry;
/**
- * Pool entry for {@link BasicNIOConnPool}.
+ * A basic {@link PoolEntry} implementation that represents an entry
+ * in a pool of non-blocking {@link NHttpClientConnection}s identified by
+ * an {@link HttpHost} instance.
*
+ * @see HttpHost
* @since 4.2
*/
@ThreadSafe
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/reactor/IOReactorConfig.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/reactor/IOReactorConfig.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
(empty)
Propchange: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/impl/nio/reactor/IOReactorConfig.java
------------------------------------------------------------------------------
svn:executable = *
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/NHttpConnectionFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/NHttpConnectionFactory.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/NHttpConnectionFactory.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/NHttpConnectionFactory.java Sat Nov 12 15:55:07 2011
@@ -30,6 +30,8 @@ package org.apache.http.nio;
import org.apache.http.nio.reactor.IOSession;
/**
+ * Factory for {@link NHttpConnection} instances.
+ *
* @since 4.2
*/
public interface NHttpConnectionFactory<T extends NHttpConnection> {
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/EntityAsyncContentProducer.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/EntityAsyncContentProducer.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/EntityAsyncContentProducer.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/EntityAsyncContentProducer.java Sat Nov 12 15:55:07 2011
@@ -38,6 +38,7 @@ import org.apache.http.nio.ContentEncode
import org.apache.http.nio.IOControl;
/**
+ * Basic implementation of {@link HttpAsyncContentProducer}.
*
* @since 4.2
*/
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/HttpAsyncContentProducer.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/HttpAsyncContentProducer.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/HttpAsyncContentProducer.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/HttpAsyncContentProducer.java Sat Nov 12 15:55:07 2011
@@ -34,15 +34,18 @@ import org.apache.http.nio.ContentEncode
import org.apache.http.nio.IOControl;
/**
+ * <tt>HttpAsyncContentProducer</tt> is a callback interface whose methods
+ * get invoked to stream out message content to a non-blocking HTTP connection
+ * through a {@link ContentEncoder}.
+ *
* @since 4.2
*/
public interface HttpAsyncContentProducer extends Closeable {
/**
- * Notification that content should be written to the encoder.
- * {@link IOControl} instance passed as a parameter to the method can be
- * used to suspend output events if the entity is temporarily unable to
- * produce more content.
+ * Invoked to write out a chunk of content to the {@link ContentEncoder}.
+ * The {@link IOControl} interface can be used to suspend output events
+ * if the entity is temporarily unable to produce more content.
* <p>
* When all content is finished, this <b>MUST</b> call {@link ContentEncoder#complete()}.
* Failure to do so could result in the entity never being written.
@@ -52,6 +55,10 @@ public interface HttpAsyncContentProduce
*/
void produceContent(ContentEncoder encoder, IOControl ioctrl) throws IOException;
+ /**
+ * Determines whether or not this producer is capable of producing
+ * its content more than once.
+ */
boolean isRepeatable();
}
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/NStringEntity.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/NStringEntity.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/NStringEntity.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/entity/NStringEntity.java Sat Nov 12 15:55:07 2011
@@ -50,7 +50,8 @@ import org.apache.http.protocol.HTTP;
*/
@SuppressWarnings("deprecation")
@NotThreadSafe
-public class NStringEntity extends AbstractHttpEntity implements ProducingNHttpEntity {
+public class NStringEntity extends AbstractHttpEntity
+ implements HttpAsyncContentProducer, ProducingNHttpEntity {
private final byte[] b;
private final ByteBuffer buf;
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/pool/NIOConnFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/pool/NIOConnFactory.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/pool/NIOConnFactory.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/pool/NIOConnFactory.java Sat Nov 12 15:55:07 2011
@@ -32,6 +32,11 @@ import java.io.IOException;
import org.apache.http.nio.reactor.IOSession;
/**
+ * Factory for poolable non-blocking connections.
+ *
+ * @param <T> the route type that represents the opposite endpoint of a pooled
+ * connection.
+ * @param <C> the connection type.
* @since 4.2
*/
public interface NIOConnFactory<T, C> {
Modified: httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/protocol/HttpAsyncRequestProducer.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/protocol/HttpAsyncRequestProducer.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/protocol/HttpAsyncRequestProducer.java (original)
+++ httpcomponents/httpcore/trunk/httpcore-nio/src/main/java/org/apache/http/nio/protocol/HttpAsyncRequestProducer.java Sat Nov 12 15:55:07 2011
@@ -29,6 +29,7 @@ package org.apache.http.nio.protocol;
import java.io.Closeable;
import java.io.IOException;
+import org.apache.http.HttpEntityEnclosingRequest;
import org.apache.http.HttpException;
import org.apache.http.HttpHost;
import org.apache.http.HttpRequest;
@@ -37,20 +38,72 @@ import org.apache.http.nio.IOControl;
import org.apache.http.protocol.HttpContext;
/**
+ * <tt>HttpAsyncRequestProducer</tt> is a callback interface whose methods
+ * get invoked to generate an HTTP request message and to stream out message
+ * content to a non-blocking HTTP connection through a {@link ContentEncoder}.
+ * <p>
+ * Repeatable request producers capable of generating the same request
+ * message more than once can be reset to their initial state by calling
+ * the {@link #resetRequest()} method, at which point request producers are
+ * expected to release currently allocated resources that are no longer needed
+ * or re-acquire resources needed to repeat the process.
+ *
* @since 4.2
*/
public interface HttpAsyncRequestProducer extends Closeable {
+ /**
+ * Invoked to obtain the request target host.
+ */
HttpHost getTarget();
+ /**
+ * Invoked to generate a HTTP request message. The message is expected
+ * to implement the {@link HttpEntityEnclosingRequest} interface if it is
+ * to enclose a content entity. The {@link #produceContent(ContentEncoder, IOControl)}
+ * method will not be invoked if {@link HttpEntityEnclosingRequest#getEntity()}
+ * returns <code>null</code>.
+ *
+ * @return HTTP request message.
+ * @throws HttpException in case of HTTP protocol violation
+ * @throws IOException in case of an I/O error
+ */
HttpRequest generateRequest() throws IOException, HttpException;
+ /**
+ * Invoked to write out a chunk of content to the {@link ContentEncoder}.
+ * The {@link IOControl} interface can be used to suspend output events
+ * if the entity is temporarily unable to produce more content.
+ * <p>
+ * When all content is finished, this <b>MUST</b> call {@link ContentEncoder#complete()}.
+ * Failure to do so could result in the entity never being written.
+ *
+ * @param encoder content encoder.
+ * @param ioctrl I/O control of the underlying connection.
+ * @throws IOException in case of an I/O error
+ */
void produceContent(ContentEncoder encoder, IOControl ioctrl) throws IOException;
+ /**
+ * Invoked to signal that the request has been fully written out.
+ *
+ * @param context HTTP context
+ */
void requestCompleted(HttpContext context);
+ /**
+ * Determines whether or not this producer is capable of producing
+ * HTTP request messages more than once.
+ */
boolean isRepeatable();
+ /**
+ * Invoked to reset the producer to its initial state. Repeatable request
+ * producers are expected to release currently allocated resources that are
+ * no longer needed or re-acquire resources needed to repeat the process.
+ *
+ * @throws IOException in case of an I/O error
+ */
void resetRequest() throws IOException;
}
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicConnFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicConnFactory.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicConnFactory.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicConnFactory.java Sat Nov 12 15:55:07 2011
@@ -43,6 +43,17 @@ import org.apache.http.pool.ConnFactory;
/**
* A very basic {@link ConnFactory} implementation that creates
* {@link HttpClientConnection} instances given a {@link HttpHost} instance.
+ * <p/>
+ * The following parameters can be used to customize the behavior of this
+ * class:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#HTTP_ELEMENT_CHARSET}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#TCP_NODELAY}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SO_TIMEOUT}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SO_LINGER}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SOCKET_BUFFER_SIZE}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_LINE_LENGTH}</li>
+ * </ul>
*
* @see HttpHost
* @since 4.2
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicConnPool.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicConnPool.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicConnPool.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicConnPool.java Sat Nov 12 15:55:07 2011
@@ -38,10 +38,21 @@ import org.apache.http.pool.ConnPool;
/**
* A very basic {@link ConnPool} implementation that represents a pool
- * of {@link HttpClientConnection} connections identified by
- * an {@link HttpHost} instance containing basic details about the connection
- * such as the scheme name, the host name and the port). This pool implementation,
- * however, cannot differentiate direct and proxied connections.
+ * of blocking {@link HttpClientConnection} connections identified by
+ * an {@link HttpHost} instance. Please note this pool implementation
+ * does not support complex routes via a proxy cannot differentiate between
+ * direct and proxied connections.
+ * <p/>
+ * The following parameters can be used to customize the behavior of this
+ * class:
+ * <ul>
+ * <li>{@link org.apache.http.params.CoreProtocolPNames#HTTP_ELEMENT_CHARSET}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#TCP_NODELAY}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SO_TIMEOUT}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SO_LINGER}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#SOCKET_BUFFER_SIZE}</li>
+ * <li>{@link org.apache.http.params.CoreConnectionPNames#MAX_LINE_LENGTH}</li>
+ * </ul>
*
* @see HttpHost
* @since 4.2
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicPoolEntry.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicPoolEntry.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicPoolEntry.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/impl/pool/BasicPoolEntry.java Sat Nov 12 15:55:07 2011
@@ -35,9 +35,8 @@ import org.apache.http.pool.PoolEntry;
/**
* A very basic {@link PoolEntry} implementation that represents an entry
- * in a pool of {@link HttpClientConnection}s identified by an {@link HttpHost}
- * instance containing basic details about the connection such as the scheme
- * name, the host name and the port)
+ * in a pool of blocking {@link HttpClientConnection}s identified by
+ * an {@link HttpHost} instance.
*
* @see HttpHost
* @since 4.2
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/pool/ConnFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/pool/ConnFactory.java?rev=1201279&r1=1201278&r2=1201279&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/pool/ConnFactory.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/pool/ConnFactory.java Sat Nov 12 15:55:07 2011
@@ -30,7 +30,7 @@ package org.apache.http.pool;
import java.io.IOException;
/**
- * Factory for poolable connections.
+ * Factory for poolable blocking connections.
*
* @param <T> the route type that represents the opposite endpoint of a pooled
* connection.