8235141: Specify the required standard socket options for the socket types in the java.net package

Reviewed-by: alanb, chegar
This commit is contained in:
Daniel Fuchs 2019-12-10 13:22:52 +00:00
parent 2c772c7887
commit 7135b5dd9c
5 changed files with 340 additions and 5 deletions

View file

@ -46,6 +46,35 @@ import sun.net.PlatformSocketImpl;
* implementation to configure itself to create sockets
* appropriate to the local firewall.
*
* <p> The {@code ServerSocket} class defines convenience
* methods to set and get several socket options. This class also
* defines the {@link #setOption(SocketOption, Object) setOption}
* and {@link #getOption(SocketOption) getOption} methods to set
* and query socket options.
* A {@code ServerSocket} supports the following options:
* <blockquote>
* <table class="striped">
* <caption style="display:none">Socket options</caption>
* <thead>
* <tr>
* <th scope="col">Option Name</th>
* <th scope="col">Description</th>
* </tr>
* </thead>
* <tbody>
* <tr>
* <th scope="row"> {@link java.net.StandardSocketOptions#SO_RCVBUF SO_RCVBUF} </th>
* <td> The size of the socket receive buffer </td>
* </tr>
* <tr>
* <th scope="row"> {@link java.net.StandardSocketOptions#SO_REUSEADDR SO_REUSEADDR} </th>
* <td> Re-use address </td>
* </tr>
* </tbody>
* </table>
* </blockquote>
* Additional (implementation specific) options may also be supported.
*
* @author unascribed
* @see java.net.SocketImpl
* @see java.net.ServerSocket#setSocketFactory(java.net.SocketImplFactory)