Apache
/
httpcomponents-client
mirror of https://github.com/apache/httpcomponents-client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc fixes 

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@651813 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Oleg Kalnichevski 2008-04-26 10:43:34 +00:00
parent f8d37586d0
commit 9b3fc0bca1
11 changed files with 33 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
module-client/src/main/java/org/apache/http/client/ClientRequestDirector.java
View File

@ -51,8 +51,6 @@ import org.apache.http.protocol.HttpContext;
* allocate connections, and return responses that depend on those
* connections for reading the response entity. Such connections
* MUST be released, but that is out of the scope of a request director.
* The {@link #getConnection getConnection} provides access to the
* connection that must be released when the response is handled.
*
* <p>
* This interface and it's implementations replace the

8
module-client/src/main/java/org/apache/http/conn/ClientConnectionRequest.java
View File

@ -2,8 +2,6 @@ package org.apache.http.conn;
import java.util.concurrent.TimeUnit;
import org.apache.http.conn.routing.HttpRoute;
/**
* Encapsulates a request for a {@link ManagedClientConnection}.
*/
@ -13,7 +11,7 @@ public interface ClientConnectionRequest {
* Obtains a connection within a given time.
* This method will block until a connection becomes available,
* the timeout expires, or the connection manager is
* {@link #shutdown shut down}.
* {@link ClientConnectionManager#shutdown() shut down}.
* Timeouts are handled with millisecond precision.
*
* If {@link #abortRequest()} is called while this is blocking or
@ -32,11 +30,11 @@ public interface ClientConnectionRequest {
* @throws InterruptedException
* if the calling thread is interrupted while waiting
*/
ManagedClientConnection getConnection(long timeout, TimeUnit unit)
ManagedClientConnection getConnection(long timeout, TimeUnit tunit)
throws InterruptedException, ConnectionPoolTimeoutException;
/**
* Aborts the call to {@link #getConnection(HttpRoute, long, TimeUnit)},
* Aborts the call to {@link #getConnection(long, TimeUnit)},
* causing it to throw an {@link InterruptedException}.
*/
void abortRequest();

6
module-client/src/main/java/org/apache/http/conn/package.html
View File

@ -48,11 +48,11 @@ The connection interface extends the core
{@link org.apache.http.HttpClientConnection HttpClientConnection}
by operations to set and update a socket.
An operator encapsulates the logic to open and layer sockets,
typically using a {@link org.apache.http.conn.SocketFactory SocketFactory}.
typically using a {@link org.apache.http.conn.scheme.SocketFactory SocketFactory}.
The socket factory for a protocol
{@link org.apache.http.conn.Scheme Scheme}
{@link org.apache.http.conn.scheme.Scheme Scheme}
such as "http" or "https" can be looked up in a
{@link org.apache.http.conn.SchemeRegistry SchemeRegistry}.
{@link org.apache.http.conn.scheme.SchemeRegistry SchemeRegistry}.
Applications without a need for sophisticated connection management
can use this layer directly.
</p>

10
module-client/src/main/java/org/apache/http/conn/params/ConnPerRoute.java
View File

@ -1,7 +1,7 @@
/*
* $HeadURL:$
* $Revision:$
* $Date:$
* $HeadURL$
* $Revision$
* $Date$
*
* ====================================================================
*
@ -33,14 +33,14 @@ package org.apache.http.conn.params;
import org.apache.http.conn.routing.HttpRoute;
/**
* This interface interface is intended to lookup maximum number of connections
* This interface is intended for looking up maximum number of connections
* allowed for for a given route. This class can be used by pooling
* {@link org.apache.http.conn.ClientConnectionManager connection managers} for
* a fine-grained control of connections on a per route basis.
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
* @version $Revision:$
* @version $Revision$
*
* @since 4.0
*/

19
module-client/src/main/java/org/apache/http/conn/params/HttpConnectionManagerParams.java
View File

@ -62,11 +62,13 @@ public final class HttpConnectionManagerParams implements ConnManagerPNames {
};
/**
* Sets maximum number of connections allowed per route lookup interface.
* Sets lookup interface for maximum number of connections allowed per route.
*
* @param max The default maximum.
* @param params HTTP parameters
* @param connPerRoute lookup interface for maximum number of connections allowed
* per route
*
* @see ConnManagerPNames#MAX_HOST_CONNECTIONS
* @see ConnManagerPNames#MAX_CONNECTIONS_PER_ROUTE
*/
public static void setMaxConnectionsPerRoute(final HttpParams params,
final ConnPerRoute connPerRoute) {
@ -78,13 +80,13 @@ public final class HttpConnectionManagerParams implements ConnManagerPNames {
}
/**
* Returns maximum number of connections allowed per route lookup interface.
* Returns lookup interface for maximum number of connections allowed per route.
*
* @param route the route for which to get the maximum connections
* @param params HTTP parameters
*
* @return The maximum number of connections allowed for the given route.
* @return lookup interface for maximum number of connections allowed per route.
*
* @see ConnManagerPNames#MAX_HOST_CONNECTIONS
* @see ConnManagerPNames#MAX_CONNECTIONS_PER_ROUTE
*/
public static ConnPerRoute getMaxConnectionsPerRoute(final HttpParams params) {
if (params == null) {
@ -102,6 +104,7 @@ public final class HttpConnectionManagerParams implements ConnManagerPNames {
/**
* Sets the maximum number of connections allowed.
*
* @param params HTTP parameters
* @param maxTotalConnections The maximum number of connections allowed.
*
* @see ConnManagerPNames#MAX_TOTAL_CONNECTIONS
@ -119,6 +122,8 @@ public final class HttpConnectionManagerParams implements ConnManagerPNames {
/**
* Gets the maximum number of connections allowed.
*
* @param params HTTP parameters
*
* @return The maximum number of connections allowed.
*
* @see ConnManagerPNames#MAX_TOTAL_CONNECTIONS

9
module-client/src/main/java/org/apache/http/impl/conn/DefaultClientConnection.java
View File

@ -121,9 +121,12 @@ public class DefaultClientConnection extends SocketHttpClientConnection
/**
* Force-closes this connection.
* If it is not yet {@link #open open} but {@link #announce announced},
* the associated socket is closed. That will interrupt a thread that
* is blocked on connecting the socket.
* If the connection is still in the process of being open (the method
* {@link #opening opening} was already called but
* {@link #openCompleted openCompleted} was not), the associated
* socket that is being connected to a remote address will be closed.
* That will interrupt a thread that is blocked on connecting
* the socket.
*
* @throws IOException in case of a problem
*/

2
module-client/src/main/java/org/apache/http/impl/conn/tsccm/AbstractConnPool.java
View File

@ -151,8 +151,6 @@ public abstract class AbstractConnPool implements RefQueueHandler {
* @param timeout the timeout, 0 or negative for no timeout
* @param tunit the unit for the <code>timeout</code>,
* may be <code>null</code> only if there is no timeout
* @param operator the connection operator, in case
* a connection has to be created
*
* @return pool entry holding a connection for the route
*

2
module-client/src/main/java/org/apache/http/impl/conn/tsccm/ConnPoolByRoute.java
View File

@ -93,8 +93,6 @@ public class ConnPoolByRoute extends AbstractConnPool {
/**
* Creates a new connection pool, managed by route.
*
* @param mgr the connection manager
*/
public ConnPoolByRoute(final ClientConnectionOperator operator, final HttpParams params) {
super();

6
module-client/src/main/java/org/apache/http/impl/conn/tsccm/PoolEntryRequest.java
View File

@ -32,9 +32,7 @@ package org.apache.http.impl.conn.tsccm;
import java.util.concurrent.TimeUnit;
import org.apache.http.conn.ClientConnectionOperator;
import org.apache.http.conn.ConnectionPoolTimeoutException;
import org.apache.http.conn.routing.HttpRoute;
/**
* Encapsulates a request for a {@link BasicPoolEntry}.
@ -59,11 +57,11 @@ public interface PoolEntryRequest {
*/
BasicPoolEntry getPoolEntry(
long timeout,
TimeUnit unit) throws InterruptedException, ConnectionPoolTimeoutException;
TimeUnit tunit) throws InterruptedException, ConnectionPoolTimeoutException;
/**
* Aborts the active or next call to
* {@link #getPoolEntry(HttpRoute, long, TimeUnit, ClientConnectionOperator)}.
* {@link #getPoolEntry(long, TimeUnit)}.
*/
void abortRequest();

2
module-client/src/main/java/org/apache/http/impl/conn/tsccm/package.html
View File

@ -138,7 +138,7 @@ A pool contains instances of
Most other classes in this package also belong to the Pool area.
<br/>
In the Operations area, you will find only the interfaces for
operated connections as defined in {@link org.apache.http.conn}.
operated connections as defined in the org.apache.http.conn package.
The connection manager will work with all correct implementations
of these interfaces. This package therefore does not define anything
specific to the Operations area.

1
pom.xml
View File

@ -99,7 +99,6 @@
</plugin>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<version>2.2-beta-1</version>
<configuration>
<descriptors>
<descriptor>src/main/assembly/bin-unix.xml</descriptor>