You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2015/11/07 22:13:19 UTC

svn commit: r1713180 - /tomcat/trunk/java/org/apache/coyote/http11/Http11Processor.java

Author: markt
Date: Sat Nov  7 21:13:19 2015
New Revision: 1713180

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

Modified:
    tomcat/trunk/java/org/apache/coyote/http11/Http11Processor.java

Modified: tomcat/trunk/java/org/apache/coyote/http11/Http11Processor.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/http11/Http11Processor.java?rev=1713180&r1=1713179&r2=1713180&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http11/Http11Processor.java (original)
+++ tomcat/trunk/java/org/apache/coyote/http11/Http11Processor.java Sat Nov  7 21:13:19 2015
@@ -381,9 +381,11 @@ public class Http11Processor extends Abs
 
 
     /**
-     * Set the maximum number of Keep-Alive requests to honor.
-     * This is to safeguard from DoS attacks.  Setting to a negative
-     * value disables the check.
+     * Set the maximum number of Keep-Alive requests to allow.
+     * This is to safeguard from DoS attacks. Setting to a negative
+     * value disables the limit.
+     *
+     * @param mkar The new maximum number of Keep-Alive requests allowed
      */
     public void setMaxKeepAliveRequests(int mkar) {
         maxKeepAliveRequests = mkar;
@@ -391,7 +393,10 @@ public class Http11Processor extends Abs
 
 
     /**
-     * Return the number of Keep-Alive requests that we will honor.
+     * Get the maximum number of Keep-Alive requests allowed. A negative value
+     * means there is no limit.
+     *
+     * @return the number of Keep-Alive requests that we will allow.
      */
     public int getMaxKeepAliveRequests() {
         return maxKeepAliveRequests;
@@ -400,6 +405,11 @@ public class Http11Processor extends Abs
 
     /**
      * Set the maximum size of a POST which will be buffered in SSL mode.
+     * When a POST is received where the security constraints require a client
+     * certificate, the POST body needs to be buffered while an SSL handshake
+     * takes place to obtain the certificate.
+     *
+     * @param msps The maximum size POST body to buffer in bytes
      */
     public void setMaxSavePostSize(int msps) {
         maxSavePostSize = msps;
@@ -408,6 +418,8 @@ public class Http11Processor extends Abs
 
     /**
      * Return the maximum size of a POST which will be buffered in SSL mode.
+     *
+     * @return The size in bytes
      */
     public int getMaxSavePostSize() {
         return maxSavePostSize;
@@ -415,7 +427,11 @@ public class Http11Processor extends Abs
 
 
     /**
-     * Set the flag to control upload time-outs.
+     * Set the flag to control whether a separate connection timeout is used
+     * during upload of a request body.
+     *
+     * @param isDisabled {@code true} if the separate upload timeout should be
+     *                   disabled
      */
     public void setDisableUploadTimeout(boolean isDisabled) {
         disableUploadTimeout = isDisabled;
@@ -423,6 +439,8 @@ public class Http11Processor extends Abs
 
     /**
      * Get the flag that controls upload time-outs.
+     *
+     * @return {@code true} if the separate upload timeout is disabled
      */
     public boolean getDisableUploadTimeout() {
         return disableUploadTimeout;
@@ -430,6 +448,8 @@ public class Http11Processor extends Abs
 
     /**
      * Set the upload timeout.
+     *
+     * @param timeout Upload timeout in milliseconds
      */
     public void setConnectionUploadTimeout(int timeout) {
         connectionUploadTimeout = timeout ;
@@ -437,6 +457,8 @@ public class Http11Processor extends Abs
 
     /**
      * Get the upload timeout.
+     *
+     * @return Upload timeout in milliseconds
      */
     public int getConnectionUploadTimeout() {
         return connectionUploadTimeout;
@@ -445,9 +467,11 @@ public class Http11Processor extends Abs
 
     /**
      * Set the server header name.
+     *
+     * @param server The new value to use for the server header
      */
-    public void setServer( String server ) {
-        if (server==null || server.equals("")) {
+    public void setServer(String server) {
+        if (server == null || server.equals("")) {
             this.server = null;
         } else {
             this.server = server;



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