Mercurial Mercurial > jdk-sandbox / changeset
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
8231719: Correct contradictions in timeout range descriptions.
authorpconcannon
Wed, 16 Oct 2019 11:12:47 +0100
changeset 58692 04946947ca79
parent 58691 eb172a3b1c1c
child 58693 3f35a9efd7de
8231719: Correct contradictions in timeout range descriptions. Summary: Clarified verbiage in method descriptions. Reviewed-by: chegar, dfuchs
src/java.base/share/classes/java/net/DatagramSocket.java file | annotate | diff | comparison | revisions
src/java.base/share/classes/java/net/ServerSocket.java file | annotate | diff | comparison | revisions
src/java.base/share/classes/java/net/Socket.java file | annotate | diff | comparison | revisions 
--- a/src/java.base/share/classes/java/net/DatagramSocket.java	Thu Oct 17 08:56:06 2019 +0100
+++ b/src/java.base/share/classes/java/net/DatagramSocket.java	Wed Oct 16 11:12:47 2019 +0100
@@ -888,14 +888,14 @@
     }
 
     /** Enable/disable SO_TIMEOUT with the specified timeout, in
-     *  milliseconds. With this option set to a non-zero timeout,
+     *  milliseconds. With this option set to a positive timeout value,
      *  a call to receive() for this DatagramSocket
      *  will block for only this amount of time.  If the timeout expires,
      *  a <B>java.net.SocketTimeoutException</B> is raised, though the
-     *  DatagramSocket is still valid.  The option <B>must</B> be enabled
-     *  prior to entering the blocking operation to have effect.  The
-     *  timeout must be {@code > 0}.
-     *  A timeout of zero is interpreted as an infinite timeout.
+     *  DatagramSocket is still valid. A timeout of zero is interpreted
+     *  as an infinite timeout.
+     *  The option <B>must</B> be enabled prior to entering the blocking
+     *  operation to have effect.
      *
      * @param timeout the specified timeout in milliseconds.
      * @throws SocketException if there is an error in the underlying protocol, such as an UDP error.
--- a/src/java.base/share/classes/java/net/ServerSocket.java	Thu Oct 17 08:56:06 2019 +0100
+++ b/src/java.base/share/classes/java/net/ServerSocket.java	Wed Oct 16 11:12:47 2019 +0100
@@ -749,14 +749,15 @@
 
     /**
      * Enable/disable {@link SocketOptions#SO_TIMEOUT SO_TIMEOUT} with the
-     * specified timeout, in milliseconds.  With this option set to a non-zero
-     * timeout, a call to accept() for this ServerSocket
+     * specified timeout, in milliseconds.  With this option set to a positive
+     * timeout value, a call to accept() for this ServerSocket
      * will block for only this amount of time.  If the timeout expires,
      * a <B>java.net.SocketTimeoutException</B> is raised, though the
-     * ServerSocket is still valid.  The option <B>must</B> be enabled
-     * prior to entering the blocking operation to have effect.  The
-     * timeout must be {@code > 0}.
-     * A timeout of zero is interpreted as an infinite timeout.
+     * ServerSocket is still valid. A timeout of zero is interpreted as an
+     * infinite timeout.
+     * The option <B>must</B> be enabled prior to entering the blocking
+     * operation to have effect.
+     *
      * @param timeout the specified timeout, in milliseconds
      * @throws  SocketException if there is an error in the underlying protocol,
      *          such as a TCP error
--- a/src/java.base/share/classes/java/net/Socket.java	Thu Oct 17 08:56:06 2019 +0100
+++ b/src/java.base/share/classes/java/net/Socket.java	Wed Oct 16 11:12:47 2019 +0100
@@ -1171,13 +1171,12 @@
     /**
      *  Enable/disable {@link SocketOptions#SO_TIMEOUT SO_TIMEOUT}
      *  with the specified timeout, in milliseconds. With this option set
-     *  to a non-zero timeout, a read() call on the InputStream associated with
+     *  to a positive timeout value, a read() call on the InputStream associated with
      *  this Socket will block for only this amount of time.  If the timeout
      *  expires, a <B>java.net.SocketTimeoutException</B> is raised, though the
-     *  Socket is still valid. The option <B>must</B> be enabled
-     *  prior to entering the blocking operation to have effect. The
-     *  timeout must be {@code > 0}.
-     *  A timeout of zero is interpreted as an infinite timeout.
+     *  Socket is still valid. A timeout of zero is interpreted as an infinite timeout.
+     *  The option <B>must</B> be enabled prior to entering the blocking operation
+     *  to have effect.
      *
      * @param timeout the specified timeout, in milliseconds.
      * @throws  SocketException if there is an error in the underlying protocol,
jdk-sandbox