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

8305206: Add @spec tags in java.base/java.* (part 1)

Browse source 
Reviewed-by: alanb, naoto, darcy, lancea, dfuchs, iris, mchung
This commit is contained in:
Jonathan Gibbons 2023-04-04 00:09:38 +00:00
parent ccbb0e8d89
commit c6bd489cc8
60 changed files with 268 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/java.base/share/classes/java/net/StandardSocketOptions.java
View file

@ -57,6 +57,8 @@ public final class StandardSocketOptions {
* require that the Java virtual machine be started with implementation
* specific privileges to enable this option or send broadcast datagrams.
*
* @spec https://www.rfc-editor.org/info/rfc919
* RFC 919: Broadcasting Internet Datagrams
* @see <a href="http://www.ietf.org/rfc/rfc919.txt">RFC&nbsp;929:
* Broadcasting Internet Datagrams</a>
* @see DatagramSocket#setBroadcast
@ -77,6 +79,8 @@ public final class StandardSocketOptions {
* <p> The initial value of this socket option is {@code FALSE}. The socket
* option may be enabled or disabled at any time.
*
* @spec https://www.rfc-editor.org/info/rfc1122
* RFC 1122: Requirements for Internet Hosts - Communication Layers
* @see <a href="http://www.ietf.org/rfc/rfc1122.txt">RFC&nbsp;1122
* Requirements for Internet Hosts -- Communication Layers</a>
* @see Socket#setKeepAlive
@ -147,6 +151,8 @@ public final class StandardSocketOptions {
* socket receive buffer to be changed after the socket is bound is system
* dependent.
*
* @spec https://www.rfc-editor.org/info/rfc1323
* RFC 1323: TCP Extensions for High Performance
* @see <a href="http://www.ietf.org/rfc/rfc1323.txt">RFC&nbsp;1323: TCP
* Extensions for High Performance</a>
* @see Socket#setReceiveBufferSize
@ -179,6 +185,8 @@ public final class StandardSocketOptions {
* after the socket is bound has no effect. The default value of this
* socket option is system dependent.
*
* @spec https://www.rfc-editor.org/info/rfc793
* RFC 793: Transmission Control Protocol
* @see <a href="http://www.ietf.org/rfc/rfc793.txt">RFC&nbsp;793: Transmission
* Control Protocol</a>
* @see ServerSocket#setReuseAddress
@ -268,6 +276,10 @@ public final class StandardSocketOptions {
* {@link StandardProtocolFamily#INET6 IPv6} socket, is not defined in this
* release.
*
* @spec https://www.rfc-editor.org/info/rfc1349
* RFC 1349: Type of Service in the Internet Protocol Suite
* @spec https://www.rfc-editor.org/info/rfc2474
* RFC 2474: Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers
* @see DatagramSocket#setTrafficClass
*/
public static final SocketOption<Integer> IP_TOS =
@ -366,6 +378,8 @@ public final class StandardSocketOptions {
* disabled. If it cannot, then invoking the {@code setOption} method to
* disable the option has no effect.
*
* @spec https://www.rfc-editor.org/info/rfc1122
* RFC 1122: Requirements for Internet Hosts - Communication Layers
* @see <a href="http://www.ietf.org/rfc/rfc1122.txt">RFC&nbsp;1122:
* Requirements for Internet Hosts -- Communication Layers</a>
* @see Socket#setTcpNoDelay