Author: olegk Date: Sat Jun 10 15:07:56 2006 New Revision: 413369 URL: http://svn.apache.org/viewvc?rev=413369&view=rev Log: [HTTPCLIENT-553] JavaDoc getConnection methods in Connection Managers
Contributed by Oleg Kalnichevski Modified: jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/MultiThreadedHttpConnectionManager.java jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/SimpleHttpConnectionManager.java Modified: jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/MultiThreadedHttpConnectionManager.java URL: http://svn.apache.org/viewvc/jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/MultiThreadedHttpConnectionManager.java?rev=413369&r1=413368&r2=413369&view=diff ============================================================================== --- jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/MultiThreadedHttpConnectionManager.java (original) +++ jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/MultiThreadedHttpConnectionManager.java Sat Jun 10 15:07:56 2006 @@ -373,7 +373,20 @@ } /** - * @see HttpConnectionManager#getConnectionWithTimeout(HostConfiguration, long) + * Gets a connection or waits if one is not available. A connection is + * available if one exists that is not being used or if fewer than + * maxHostConnections have been created in the connectionPool, and fewer + * than maxTotalConnections have been created in all connectionPools. + * + * @param hostConfiguration The host configuration specifying the connection + * details. + * @param timeout the number of milliseconds to wait for a connection, 0 to + * wait indefinitely + * + * @return HttpConnection an available connection + * + * @throws HttpException if a connection does not become available in + * 'timeout' milliseconds * * @since 3.0 */ @@ -414,21 +427,6 @@ } } - /** - * Gets a connection or waits if one is not available. A connection is - * available if one exists that is not being used or if fewer than - * maxHostConnections have been created in the connectionPool, and fewer - * than maxTotalConnections have been created in all connectionPools. - * - * @param hostConfiguration The host configuration. - * @param timeout the number of milliseconds to wait for a connection, 0 to - * wait indefinitely - * - * @return HttpConnection an available connection - * - * @throws HttpException if a connection does not become available in - * 'timeout' milliseconds - */ private HttpConnection doGetConnection(HostConfiguration hostConfiguration, long timeout) throws ConnectionPoolTimeoutException { Modified: jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/SimpleHttpConnectionManager.java URL: http://svn.apache.org/viewvc/jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/SimpleHttpConnectionManager.java?rev=413369&r1=413368&r2=413369&view=diff ============================================================================== --- jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/SimpleHttpConnectionManager.java (original) +++ jakarta/commons/proper/httpclient/trunk/src/java/org/apache/commons/httpclient/SimpleHttpConnectionManager.java Sat Jun 10 15:07:56 2006 @@ -138,8 +138,13 @@ } /** - * @see HttpConnectionManager#getConnectionWithTimeout(HostConfiguration, long) + * This method always returns the same connection object. If the connection is already + * open, it will be closed and the new host configuration will be applied. * + * @param hostConfiguration The host configuration specifying the connection + * details. + * @param timeout this parameter has no effect. The connection is always returned + * immediately. * @since 3.0 */ public HttpConnection getConnectionWithTimeout( --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]