hc-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jeffrey Dever <jsde...@sympatico.ca>
Subject Re: javadoc patch
Date Tue, 21 Jan 2003 22:58:34 GMT
Committed.

Jeffrey Dever wrote:

> Just some javadoc improvements:
>
> ChangeLog:
>    - added external links to 1.4.1 javadoc and logging in the build.xml
>    - parameterized the value for setTcpNoDelay as per setSoTimeout
>    - added a class comment about setting values on sockets
>    - eliminated all javadoc warnings
>
> I also have some simple package.html files for util, protocol etc.
>
> Jandalf
>
>------------------------------------------------------------------------
>
>? .build.xml.swp
>? javadoc.diff
>Index: build.xml
>===================================================================
>RCS file: /home/cvs/jakarta-commons/httpclient/build.xml,v
>retrieving revision 1.23
>diff -u -r1.23 build.xml
>--- build.xml	16 Dec 2002 19:25:55 -0000	1.23
>+++ build.xml	21 Jan 2003 16:01:44 -0000
>@@ -22,6 +22,11 @@
> 
>   <property name="commons-logging.jar" value="${lib.dir}/commons-logging.jar"/>
> 
>+<!-- ========== Properties: Javadoc Properties    ========================= -->
>+
>+  <property name="javadoc.j2sdk.link" value="http://java.sun.com/j2se/1.4.1/docs/api"/>
>+  <property name="javadoc.logging.link" value="http://jakarta.apache.org/commons/logging/apidocs/"/>
>+
> <!-- ========== Properties: Component Declarations ======================== -->
> 
>   <!-- The name of this component -->
>@@ -364,8 +369,11 @@
>              version      ="true"
>              doctitle     ="&lt;h1&gt;${component.title}&lt;/h1&gt;"
>              windowtitle  ="${component.title} (Version ${component.version})"
>-             bottom       ="Copyright (c) 2001-2002 - Apache Software Foundation">
>+             bottom       ="Copyright (c) 1999-2002 - Apache Software Foundation"
>+    >
>       <classpath refid="test.classpath"/>
>+      <link href="${javadoc.j2sdk.link}"/>
>+      <link href="${javadoc.logging.link}"/>
>     </javadoc>
>   </target>
> 
>Index: src/java/org/apache/commons/httpclient/HttpConnection.java
>===================================================================
>RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConnection.java,v
>retrieving revision 1.33
>diff -u -r1.33 HttpConnection.java
>--- src/java/org/apache/commons/httpclient/HttpConnection.java	21 Jan 2003 09:47:26 -0000
1.33
>+++ src/java/org/apache/commons/httpclient/HttpConnection.java	21 Jan 2003 16:01:48 -0000
>@@ -80,13 +80,29 @@
> 
> 
> /**
>- * <p>
>  * An abstraction of an HTTP {@link InputStream} and {@link OutputStream}
>  * pair, together with the relevant attributes.
>- * </p>
>+ * <p>
>+ * The following options are set on the socket before getting the input/output 
>+ * streams in the {@link #open()} method:
>+ * <table border=1><tr>
>+ *    <th>Socket Method
>+ *    <th>Sockets Option
>+ *    <th>Configuration
>+ * </tr><tr>
>+ *    <td>{@link java.net.Socket#setTcpNoDelay(boolean)}
>+ *    <td>SO_NODELAY
>+ *    <td>None
>+ * </tr><tr>
>+ *    <td>{@link java.net.Socket#setSoTimeout(int)}
>+ *    <td>SO_TIMEOUT
>+ *    <td>{@link #setConnectionTimeout(int)}
>+ * </tr></table>
>+ *
>  * @author Rod Waldhoff
>  * @author Sean C. Sullivan
>  * @author Ortwin Gl├╝ck
>+ * @author Jeff Dever
>  * @version $Revision: 1.33 $ $Date: 2003/01/21 09:47:26 $
>  */
> public class HttpConnection {
>@@ -436,6 +452,7 @@
>     /**
>      * Open this connection to the current host and port
>      * (via a proxy if so configured).
>+     * The underlying socket is created from the {@link ProtocolSocketFactory}.
>      *
>      * @throws IOException when there are errors opening the connection
>      */
>@@ -480,7 +497,7 @@
>             situations. In such cases, nagling may be turned off through 
>             use of the TCP_NODELAY sockets option." */
>             
>-            _socket.setTcpNoDelay(true);
>+            _socket.setTcpNoDelay(_so_nodelay);
>             _socket.setSoTimeout(_so_timeout);
>             _input = _socket.getInputStream();
>             _output = _socket.getOutputStream();
>@@ -987,8 +1004,10 @@
>     private Protocol _protocol;
>     /** <tt>"\r\n"</tt>, as bytes. */
>     private static final byte[] CRLF = HttpConstants.getBytes("\r\n");
>-    /** SO_TIMEOUT value */
>+    /** SO_TIMEOUT socket value */
>     private int _so_timeout = 0;
>+    /** TCP_NODELAY socket value */
>+    private boolean _so_nodelay = true;
>     /** Whether or not the _socket is a secure one. Note the difference to _ssl */
>     private boolean _usingSecureSocket = false;
>     /** Whether I am tunneling a proxy or not */
>Index: src/java/org/apache/commons/httpclient/protocol/DefaultProtocolSocketFactory.java
>===================================================================
>RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/DefaultProtocolSocketFactory.java,v
>retrieving revision 1.1
>diff -u -r1.1 DefaultProtocolSocketFactory.java
>--- src/java/org/apache/commons/httpclient/protocol/DefaultProtocolSocketFactory.java
16 Jan 2003 13:28:40 -0000	1.1
>+++ src/java/org/apache/commons/httpclient/protocol/DefaultProtocolSocketFactory.java
21 Jan 2003 16:01:50 -0000
>@@ -82,7 +82,7 @@
>     }
> 
>     /**
>-     * @see org.apache.commons.httpclient.ProtocolSocketFactory#createSocket(java.lang.String,
int, java.net.InetAddress, int)
>+     * @see #createSocket(java.lang.String,int,java.net.InetAddress,int)
>      */
>     public Socket createSocket(
>         String host,
>@@ -94,7 +94,7 @@
>     }
> 
>     /**
>-     * @see org.apache.commons.httpclient.ProtocolSocketFactory#createSocket(java.lang.String,
int)
>+     * @see ProtocolSocketFactory#createSocket(java.lang.String,int)
>      */
>     public Socket createSocket(String host, int port)
>         throws IOException, UnknownHostException {
>Index: src/java/org/apache/commons/httpclient/protocol/ProtocolSocketFactory.java
>===================================================================
>RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/ProtocolSocketFactory.java,v
>retrieving revision 1.1
>diff -u -r1.1 ProtocolSocketFactory.java
>--- src/java/org/apache/commons/httpclient/protocol/ProtocolSocketFactory.java	16 Jan
2003 13:28:40 -0000	1.1
>+++ src/java/org/apache/commons/httpclient/protocol/ProtocolSocketFactory.java	21 Jan
2003 16:01:50 -0000
>@@ -67,7 +67,7 @@
> /**
>  * A factory for creating Sockets.
>  * 
>- * @see org.apache.commons.httpclient.Protocol
>+ * @see Protocol
>  * 
>  * @author Michael Becke
>  * 
>Index: src/java/org/apache/commons/httpclient/protocol/SSLProtocolSocketFactory.java
>===================================================================
>RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/SSLProtocolSocketFactory.java,v
>retrieving revision 1.1
>diff -u -r1.1 SSLProtocolSocketFactory.java
>--- src/java/org/apache/commons/httpclient/protocol/SSLProtocolSocketFactory.java	16 Jan
2003 13:28:40 -0000	1.1
>+++ src/java/org/apache/commons/httpclient/protocol/SSLProtocolSocketFactory.java	21 Jan
2003 16:01:50 -0000
>@@ -83,7 +83,7 @@
>     }
> 
>     /**
>-     * @see org.apache.commons.httpclient.ProtocolSocketFactory#createSocket(java.lang.String,
int, java.net.InetAddress, int)
>+     * @see SecureProtocolSocketFactory#createSocket(java.lang.String,int,java.net.InetAddress,int)
>      */
>     public Socket createSocket(
>         String host,
>@@ -100,7 +100,7 @@
>     }
> 
>     /**
>-     * @see org.apache.commons.httpclient.ProtocolSocketFactory#createSocket(java.lang.String,
int)
>+     * @see SecureProtocolSocketFactory#createSocket(java.lang.String,int)
>      */
>     public Socket createSocket(String host, int port)
>         throws IOException, UnknownHostException {
>@@ -111,7 +111,7 @@
>     }
> 
>     /**
>-     * @see org.apache.commons.httpclient.SecureProtocolSocketFactory#createSocket(java.net.Socket,
java.lang.String, int, boolean)
>+     * @see SecureProtocolSocketFactory#createSocket(java.net.Socket,java.lang.String,int,boolean)
>      */
>     public Socket createSocket(
>         Socket socket,
>
>  
>
>------------------------------------------------------------------------
>
>--
>To unsubscribe, e-mail:   <mailto:commons-httpclient-dev-unsubscribe@jakarta.apache.org>
>For additional commands, e-mail: <mailto:commons-httpclient-dev-help@jakarta.apache.org>
>


Mime
View raw message