svn commit: r764584 - in /httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/params: CoreConnectionPNames.java CoreProtocolPNames.java

[ol...@apache.org]

Author: olegk
Date: Mon Apr 13 19:49:40 2009
New Revision: 764584

URL: http://svn.apache.org/viewvc?rev=764584&view=rev
Log:
Javadoc updates

Modified:
    httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/params/CoreConnectionPNames.java
    httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/params/CoreProtocolPNames.java

Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/params/CoreConnectionPNames.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/params/CoreConnectionPNames.java?rev=764584&r1=764583&r2=764584&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/params/CoreConnectionPNames.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/params/CoreConnectionPNames.java Mon Apr 13 19:49:40 2009
@@ -42,8 +42,9 @@
 
     /**
      * Defines the socket timeout (<code>SO_TIMEOUT</code>) in milliseconds,
-     * which is the timeout for waiting for data. A timeout value of zero is 
-     * interpreted as an infinite timeout. 
+     * which is the timeout for waiting for data  or, put differently, 
+     * a maximum period inactivity between two consecutive data packets). 
+     * A timeout value of zero is interpreted as an infinite timeout. 
      * <p>
      * This parameter expects a value of type {@link Integer}.
      * </p>
@@ -78,7 +79,7 @@
      * Sets SO_LINGER with the specified linger time in seconds. The maximum 
      * timeout value is platform specific. Value <code>0</code> implies that 
      * the option is disabled. Value <code>-1</code> implies that the JRE 
-     * default is used. The setting only affects  socket close.  
+     * default is used. The setting only affects the socket close operation.  
      * <p>
      * This parameter expects a value of type {@link Integer}.
      * </p>
@@ -96,10 +97,10 @@
     public static final String CONNECTION_TIMEOUT = "http.connection.timeout"; 
 
     /**
-     * Determines whether stale connection check is to be used. Disabling 
-     * stale connection check may result in slight performance improvement 
-     * at the risk of getting an I/O error when executing a request over a
-     * connection that has been closed at the server side. 
+     * Determines whether stale connection check is to be used. The stale 
+     * connection check can cause up to 30 millisecond overhead per request and  
+     * should be used only when appropriate. For performance critical 
+     * operations this check should be disabled.
      * <p>
      * This parameter expects a value of type {@link Boolean}.
      * </p>

Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/params/CoreProtocolPNames.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/params/CoreProtocolPNames.java?rev=764584&r1=764583&r2=764584&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/params/CoreProtocolPNames.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/params/CoreProtocolPNames.java Mon Apr 13 19:49:40 2009
@@ -95,7 +95,7 @@
      * <p>
      * Activates 'Expect: 100-Continue' handshake for the 
      * entity enclosing methods. The purpose of the 'Expect: 100-Continue'
-     * handshake to allow a client that is sending a request message with 
+     * handshake is to allow a client that is sending a request message with 
      * a request body to determine if the origin server is willing to 
      * accept the request (based on the request headers) before the client
      * sends the request body.
@@ -103,7 +103,7 @@
      * 
      * <p>
      * The use of the 'Expect: 100-continue' handshake can result in 
-     * noticable peformance improvement for entity enclosing requests
+     * a noticeable performance improvement for entity enclosing requests
      * (such as POST and PUT) that require the target server's 
      * authentication.
      * </p>