svn commit: r1682373 - in /tomcat/trunk/java/org/apache/coyote: RequestInfo.java UpgradeProtocol.java http11/OutputFilter.java

[markt]

Author: markt
Date: Fri May 29 06:56:14 2015
New Revision: 1682373

URL: http://svn.apache.org/r1682373
Log:
Javadoc

Modified:
    tomcat/trunk/java/org/apache/coyote/RequestInfo.java
    tomcat/trunk/java/org/apache/coyote/UpgradeProtocol.java
    tomcat/trunk/java/org/apache/coyote/http11/OutputFilter.java

Modified: tomcat/trunk/java/org/apache/coyote/RequestInfo.java
URL: 
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/RequestInfo.java?rev=1682373&r1=1682372&r2=1682373&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/RequestInfo.java (original)
+++ tomcat/trunk/java/org/apache/coyote/RequestInfo.java Fri May 29 06:56:14 
2015
@@ -101,6 +101,8 @@ public class RequestInfo  {
     /**
      * Obtain the remote address for this connection as reported by an
      * intermediate proxy (if any).
+     *
+     * @return The remote address for the this connection
      */
     public String getRemoteAddrForwarded() {
         String remoteAddrProxy = (String) 
req.getAttribute(Constants.REMOTE_ADDR_ATTRIBUTE);

Modified: tomcat/trunk/java/org/apache/coyote/UpgradeProtocol.java
URL: 
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/UpgradeProtocol.java?rev=1682373&r1=1682372&r2=1682373&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/UpgradeProtocol.java (original)
+++ tomcat/trunk/java/org/apache/coyote/UpgradeProtocol.java Fri May 29 
06:56:14 2015
@@ -54,6 +54,10 @@ public interface UpgradeProtocol {
     public String getAlpnName();
 
     /**
+     * @param socketWrapper The socketWrapper for the connection that requires
+     *                      a processor
+     * @param adapter The Adapter instance that provides access to the standard
+     *                Engine/Host/Context/Wrapper processing chain
      *
      * @return A processor instance for processing a connection using this
      *         protocol.

Modified: tomcat/trunk/java/org/apache/coyote/http11/OutputFilter.java
URL: 
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/coyote/http11/OutputFilter.java?rev=1682373&r1=1682372&r2=1682373&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/coyote/http11/OutputFilter.java (original)
+++ tomcat/trunk/java/org/apache/coyote/http11/OutputFilter.java Fri May 29 
06:56:14 2015
@@ -34,6 +34,8 @@ public interface OutputFilter extends Ou
      * Some filters need additional parameters from the response. All the
      * necessary reading can occur in that method, as this method is called
      * after the response header processing is complete.
+     *
+     * @param response The response to associate with this OutputFilter
      */
     public void setResponse(Response response);
 
@@ -46,6 +48,8 @@ public interface OutputFilter extends Ou
 
     /**
      * Set the next buffer in the filter pipeline.
+     *
+     * @param buffer The next buffer instance
      */
     public void setBuffer(OutputBuffer buffer);
 
@@ -58,9 +62,8 @@ public interface OutputFilter extends Ou
      * delimitation, in which case the number is the amount of extra bytes or
      * missing bytes, which would indicate an error.
      * Note: It is recommended that extra bytes be swallowed by the filter.
+     *
+     * @throws IOException If an I/O error occurs while writing to the client
      */
-    public long end()
-        throws IOException;
-
-
+    public long end() throws IOException;
 }



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