commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mbe...@apache.org
Subject cvs commit: jakarta-commons/httpclient/xdocs threading.xml
Date Tue, 28 Oct 2003 01:58:18 GMT
mbecke      2003/10/27 17:58:18

  Modified:    httpclient/src/java/org/apache/commons/httpclient
                        HttpConnection.java
               httpclient/xdocs threading.xml
  Log:
  Adds connection stale checking docs.
  
  PR: 23988
  Submitted by: Michael Becke
  Reviewed by: Oleg Kalnichevski
  
  Revision  Changes    Path
  1.77      +9 -4      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConnection.java
  
  Index: HttpConnection.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConnection.java,v
  retrieving revision 1.76
  retrieving revision 1.77
  diff -u -r1.76 -r1.77
  --- HttpConnection.java	22 Oct 2003 19:31:00 -0000	1.76
  +++ HttpConnection.java	28 Oct 2003 01:58:17 -0000	1.77
  @@ -426,6 +426,11 @@
       /**
        * Sets whether or not isStale() will be called when testing if this connection is
open.
        * 
  +     * <p>Setting this flag to <code>false</code> will increase performance
when reusing
  +     * connections, but it will also make them less reliable.  Stale checking ensures that
  +     * connections are viable before they are used.  When set to <code>false</code>
some
  +     * method executions will result in IOExceptions and they will have to be retried.</p>
  +     * 
        * @param staleCheckEnabled <code>true</code> to enable isStale()
        * 
        * @see #isStale()
  
  
  
  1.3       +10 -4     jakarta-commons/httpclient/xdocs/threading.xml
  
  Index: threading.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/xdocs/threading.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- threading.xml	21 Aug 2003 16:08:54 -0000	1.2
  +++ threading.xml	28 Oct 2003 01:58:18 -0000	1.3
  @@ -13,7 +13,7 @@
         multi-threaded environment. It is broken down into the following main sections: </p>
         <ul>
         	<li><a href="#MultiThreadedHttpConnectionManager">MultiThreadedHttpConnectionManager</a></li>
  -	    <li><a href="#ConnectionRelease">Connection Release</a></li>
  +	    <li><a href="#Connection Release">Connection Release</a></li>
   	  </ul>
         <p>Please see the <a href="http://cvs.apache.org/viewcvs.cgi/jakarta-commons/httpclient/src/examples/MultiThreadedExample.java?rev=1.1&amp;content-type=text/vnd.viewcvs-markup">MultiThreadedExample</a>
         	for a concrete example.</p>
  @@ -39,9 +39,15 @@
         	to the method and as a result it must also be returned.  More on this below in <b>Connection
Release</b>.</p>
         	
         <subsection name="Options">
  -      	<p>The MultiThreadedHttpConnectionManager supports the following options for
  -      	customizing the number of active connections:</p>
  +      	<p>The MultiThreadedHttpConnectionManager supports the following options:</p>
         	<table>
  +      	  <tr>
  +      	  	<td>connectionStaleCheckingEnabled</td>
  +      	  	<td>The <tt>connectionStaleCheckingEnabled</tt> flag to set
on all created connections.  This value 
  +      	  	should be left <tt>true</tt> except in special circumstances.  Consult
the 
  +      	  	<a href="apidocs/org/apache/commons/httpclient/HttpConnection.html#setStaleCheckingEnabled(boolean)">HttpConnection</a>

  +      	  	docs for more detail.</td>
  +      	  </tr>
         	  <tr>
         	    <td>maxConnectionsPerHost</td>
         	    <td>The maximum number of connections that will be created for any particular

  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message