archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-27 06:45:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8231719: Correct contradictions in timeout range descriptions

Browse source 
Clarified verbiage in method descriptions.

Reviewed-by: chegar, dfuchs
This commit is contained in:
Patrick Concannon 2019-10-16 11:12:47 +01:00
parent f8440c33d2
commit c497b2b066
3 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/java.base/share/classes/java/net/Socket.java
View file

@ -1171,13 +1171,12 @@ class Socket implements java.io.Closeable {
/**
* 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,