You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by gg...@apache.org on 2014/06/19 17:32:54 UTC
svn commit: r1603922 - in
/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http:
ConnectionReuseStrategy.java config/SocketConfig.java package-info.java
Author: ggregory
Date: Thu Jun 19 15:32:54 2014
New Revision: 1603922
URL: http://svn.apache.org/r1603922
Log:
Javadoc fixes for Java 8.
Modified:
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/ConnectionReuseStrategy.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/config/SocketConfig.java
httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/package-info.java
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/ConnectionReuseStrategy.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/ConnectionReuseStrategy.java?rev=1603922&r1=1603921&r2=1603922&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/ConnectionReuseStrategy.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/ConnectionReuseStrategy.java Thu Jun 19 15:32:54 2014
@@ -47,15 +47,17 @@ public interface ConnectionReuseStrategy
* close the connection to correctly comply with the HTTP protocol.
* If it returns <code>true</code>, the caller SHOULD attempt to
* keep the connection open for reuse with another request.
- * <br/>
+ * <p>
* One can use the HTTP context to retrieve additional objects that
* may be relevant for the keep-alive strategy: the actual HTTP
* connection, the original HTTP request, target host if known,
* number of times the connection has been reused already and so on.
- * <br/>
+ * </p>
+ * <p>
* If the connection is already closed, <code>false</code> is returned.
* The stale connection check MUST NOT be triggered by a
* connection reuse strategy.
+ * </p>
*
* @param response
* The last response received over that connection.
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/config/SocketConfig.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/config/SocketConfig.java?rev=1603922&r1=1603921&r2=1603922&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/config/SocketConfig.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/config/SocketConfig.java Thu Jun 19 15:32:54 2014
@@ -75,6 +75,7 @@ public class SocketConfig implements Clo
* Default: <code>0</code> (no timeout)
* </p>
*
+ * @return the default socket timeout value for non-blocking I/O operations.
* @see java.net.SocketOptions#SO_TIMEOUT
*/
public int getSoTimeout() {
@@ -88,6 +89,7 @@ public class SocketConfig implements Clo
* Default: <code>false</code>
* </p>
*
+ * @return the default value of the {@link java.net.SocketOptions#SO_REUSEADDR} parameter.
* @see java.net.SocketOptions#SO_REUSEADDR
*/
public boolean isSoReuseAddress() {
@@ -101,6 +103,7 @@ public class SocketConfig implements Clo
* Default: <code>-1</code>
* </p>
*
+ * @return the default value of the {@link java.net.SocketOptions#SO_LINGER} parameter.
* @see java.net.SocketOptions#SO_LINGER
*/
public int getSoLinger() {
@@ -114,6 +117,7 @@ public class SocketConfig implements Clo
* Default: <code>-1</code>
* </p>
*
+ * @return the default value of the {@link java.net.SocketOptions#SO_KEEPALIVE} parameter.
* @see java.net.SocketOptions#SO_KEEPALIVE
*/
public boolean isSoKeepAlive() {
@@ -127,6 +131,7 @@ public class SocketConfig implements Clo
* Default: <code>false</code>
* </p>
*
+ * @return the default value of the {@link java.net.SocketOptions#TCP_NODELAY} parameter.
* @see java.net.SocketOptions#TCP_NODELAY
*/
public boolean isTcpNoDelay() {
@@ -140,8 +145,8 @@ public class SocketConfig implements Clo
* Default: <code>0</code> (system default)
* </p>
*
+ * @return the default value of the {@link java.net.SocketOptions#SO_SNDBUF} parameter.
* @see java.net.SocketOptions#SO_SNDBUF
- *
* @since 4.4
*/
public int getSndBufSize() {
@@ -155,8 +160,8 @@ public class SocketConfig implements Clo
* Default: <code>0</code> (system default)
* </p>
*
+ * @return the default value of the {@link java.net.SocketOptions#SO_RCVBUF} parameter.
* @see java.net.SocketOptions#SO_RCVBUF
- *
* @since 4.4
*/
public int getRcvBufSize() {
@@ -169,6 +174,7 @@ public class SocketConfig implements Clo
* <p>
* Default: <code>0</code> (system default)
* </p>
+ * @return the maximum queue length for incoming connection indications
* @since 4.4
*/
public int getBacklogSize() {
Modified: httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/package-info.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/package-info.java?rev=1603922&r1=1603921&r2=1603922&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/package-info.java (original)
+++ httpcomponents/httpcore/trunk/httpcore/src/main/java/org/apache/http/package-info.java Thu Jun 19 15:32:54 2014
@@ -27,7 +27,7 @@
/**
* Core HTTP component APIs and primitives.
- * <p/>
+ * <p>
* These deal with the fundamental things required for using the
* HTTP protocol, such as representing a
* {@link org.apache.http.HttpMessage message} including it's
@@ -38,5 +38,6 @@
* before sending or after receiving, there are interceptors for
* {@link org.apache.http.HttpRequestInterceptor requests} and
* {@link org.apache.http.HttpResponseInterceptor responses}.
+ * </p>
*/
package org.apache.http;