You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by js...@apache.org on 2003/01/21 23:09:32 UTC
cvs commit: jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/util package.html
jsdever 2003/01/21 14:09:32
Modified: httpclient build.xml
httpclient/src/java/org/apache/commons/httpclient
HttpConnection.java
httpclient/src/java/org/apache/commons/httpclient/protocol
DefaultProtocolSocketFactory.java
ProtocolSocketFactory.java
SSLProtocolSocketFactory.java
Added: httpclient/src/java/org/apache/commons/httpclient/cookie
package.html
httpclient/src/java/org/apache/commons/httpclient/methods/multipart
package.html
httpclient/src/java/org/apache/commons/httpclient/protocol
package.html
httpclient/src/java/org/apache/commons/httpclient/util
package.html
Log:
Javadoc improvements datamember for controling setTcpNoDelay:
Contributed by: Jeff Dever
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
- added package.html files for the subpackages
Revision Changes Path
1.24 +10 -2 jakarta-commons/httpclient/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/httpclient/build.xml,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- build.xml 16 Dec 2002 19:25:55 -0000 1.23
+++ build.xml 21 Jan 2003 22:09:31 -0000 1.24
@@ -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 ="<h1>${component.title}</h1>"
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>
1.34 +27 -8 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.33
retrieving revision 1.34
diff -u -r1.33 -r1.34
--- HttpConnection.java 21 Jan 2003 09:47:26 -0000 1.33
+++ HttpConnection.java 21 Jan 2003 22:09:31 -0000 1.34
@@ -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$ $Date$
*/
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 */
1.1 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/cookie/package.html
Index: package.html
===================================================================
<!-- $Id: package.html,v 1.1 2003/01/21 22:09:31 jsdever Exp $ -->
<html>
<head>
<title>Package Documentation for org.apache.commons.httpclient.cookie</title>
</head>
<body>
Provides cookie handling in conjunction with {@link org.apache.commons.httpclient.Cookie}.
@since 2.0
</body>
</html>
1.1 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/multipart/package.html
Index: package.html
===================================================================
<!-- $Id: package.html,v 1.1 2003/01/21 22:09:31 jsdever Exp $ -->
<html>
<head>
<title>Package Documentation for org.apache.commons.httpclient.methods.multipart</title>
</head>
<body>
Provides Multipart support classes for the {@link org.apache.commons.httpclient.methods.MultipartPostMethod}.
@since 2.0
</body>
</html>
1.2 +2 -2 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/DefaultProtocolSocketFactory.java
Index: DefaultProtocolSocketFactory.java
===================================================================
RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/DefaultProtocolSocketFactory.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DefaultProtocolSocketFactory.java 16 Jan 2003 13:28:40 -0000 1.1
+++ DefaultProtocolSocketFactory.java 21 Jan 2003 22:09:31 -0000 1.2
@@ -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 {
1.2 +1 -1 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/ProtocolSocketFactory.java
Index: ProtocolSocketFactory.java
===================================================================
RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/ProtocolSocketFactory.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ProtocolSocketFactory.java 16 Jan 2003 13:28:40 -0000 1.1
+++ ProtocolSocketFactory.java 21 Jan 2003 22:09:32 -0000 1.2
@@ -67,7 +67,7 @@
/**
* A factory for creating Sockets.
*
- * @see org.apache.commons.httpclient.Protocol
+ * @see Protocol
*
* @author Michael Becke
*
1.2 +3 -3 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/SSLProtocolSocketFactory.java
Index: SSLProtocolSocketFactory.java
===================================================================
RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/SSLProtocolSocketFactory.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SSLProtocolSocketFactory.java 16 Jan 2003 13:28:40 -0000 1.1
+++ SSLProtocolSocketFactory.java 21 Jan 2003 22:09:32 -0000 1.2
@@ -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,
1.1 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/package.html
Index: package.html
===================================================================
<!-- $Id: package.html,v 1.1 2003/01/21 22:09:32 jsdever Exp $ -->
<html>
<head>
<title>Package Documentation for org.apache.commons.httpclient.protocol</title>
</head>
<body>
Provides protocol specific socket factory handling.
@since 2.0
</body>
</html>
1.1 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/util/package.html
Index: package.html
===================================================================
<!-- $Id: package.html,v 1.1 2003/01/21 22:09:32 jsdever Exp $ -->
<html>
<head>
<title>Package Documentation for org.apache.commons.httpclient.util</title>
</head>
<body>
Provides some utility classes for use by HttpClient.
@since 2.0
</body>
</html>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>