stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8329825: Clarify the value type for java.net.SocketOptions.SO_LINGER

Browse Source 
Reviewed-by: alanb, dfuchs
This commit is contained in:
Jaikiran Pai 2024-05-22 01:20:51 +00:00
parent 52eda79522
commit 5f804b2ec1
1 changed files with 7 additions and 0 deletions

7
src/java.base/share/classes/java/net/SocketOptions.java

@ -190,6 +190,13 @@ public interface SocketOptions {
/** /**
* See {@link StandardSocketOptions#SO_LINGER} for description of this socket option. * See {@link StandardSocketOptions#SO_LINGER} for description of this socket option.
* <p>
* Set the value to {@code Boolean.FALSE} or an integer less than {@code 0} with
* {@link #setOption(int, Object)} to disable this option. An integer greater than or equal to
* {@code 0} will enable the option and will represent the linger interval.
* <p>
* If this option is enabled then {@link #getOption(int)} will return an integer value
* representing the linger interval, else the return value will be {@code Boolean.FALSE}.
* *
* @see Socket#setSoLinger * @see Socket#setSoLinger
* @see Socket#getSoLinger * @see Socket#getSoLinger