RFR: 8329733: Update the documentation in java.net.SocketOptions to direct to java.net.StandardSocketOptions [v2]

Jaikiran Pai jpai at openjdk.org
Sat Apr 6 08:44:09 UTC 2024


On Fri, 5 Apr 2024 11:49:25 GMT, Jaikiran Pai <jpai at openjdk.org> wrote:

>> Can I please get a review of this doc-only change which proposes to clean up the documentation of `java.net.SocketOptions` interface?
>> 
>> As noted in https://bugs.openjdk.org/browse/JDK-8329733, the existing documentation in this legacy interface isn't accurate. The commit in this PR, updates the documentation on several of the fields to point to the newer java.net.StandardSocketOptions class. While at it, I also did a general update of this documentation to use snippets and also reword some of it to be a bit more clear.
>> 
>> I have run `make docs-image` on this change and the updated doc looks fine to me.
>
> Jaikiran Pai has updated the pull request incrementally with three additional commits since the last revision:
> 
>  - "timeout value" instead of "timeout"
>  - missed SO_TIMEOUT review suggestion in previous commit
>  - Alan's review suggestions

Alan, in context of another old issue https://bugs.openjdk.org/browse/JDK-6431396 would you want anything more to be added/updated for the `SO_BINDADDR` field's javadoc as part of this PR? The current update in PR already takes into account that a Socket instance can be created unbounded.

-------------

PR Comment: https://git.openjdk.org/jdk/pull/18645#issuecomment-2041019163


More information about the net-dev mailing list