rsocket-branch: clean up options spec in RdmaSockets rsocket-branch
authorbpb
Tue, 05 Feb 2019 14:19:11 -0800
branchrsocket-branch
changeset 57149 87484051dbba
parent 57142 78d016915473
child 57153 95c486f5c444
rsocket-branch: clean up options spec in RdmaSockets
src/jdk.net/share/classes/jdk/net/RdmaSockets.java
--- a/src/jdk.net/share/classes/jdk/net/RdmaSockets.java	Mon Feb 04 13:23:24 2019 -0800
+++ b/src/jdk.net/share/classes/jdk/net/RdmaSockets.java	Tue Feb 05 14:19:11 2019 -0800
@@ -77,9 +77,13 @@
     /**
      * Creates an unbound and unconnected RDMA socket.
      *
-     * <p> An RDMA socket supports the same socket options that {@link
-     * java.net.Socket java.net.Socket} defines. In addition, it supports the
-     * socket options specified by {@link RdmaSocketOptions}.
+     * <p> An RDMA socket supports the socket options
+     * {@link java.net.StandardSocketOptions#SO_RCVBUF SO_RCVBUF},
+     * {@link java.net.StandardSocketOptions#SO_REUSEADDR SO_REUSEADDR},
+     * {@link java.net.StandardSocketOptions#SO_SNDBUF SO_SNDBUF}, and
+     * {@link java.net.StandardSocketOptions#TCP_NODELAY TCP_NODELAY}
+     * defined by {@link java.net.Socket java.net.Socket}. In addition,
+     * it supports the socket options specified by {@link RdmaSocketOptions}.
      *
      * <p> When binding the socket to a local address, or invoking {@code
      * connect} to connect the socket, the socket address specified to those
@@ -107,8 +111,12 @@
     /**
      * Creates an unbound RDMA server socket.
      *
-     * <p> An RDMA socket supports the same socket options that {@link
-     * java.net.ServerSocket java.net.ServerSocket} defines.
+     * <p> An RDMA server socket supports the socket options
+     * {@link java.net.StandardSocketOptions#SO_RCVBUF SO_RCVBUF} and
+     * {@link java.net.StandardSocketOptions#SO_REUSEADDR SO_REUSEADDR}
+     * defined by {@link java.net.ServerSocket java.net.ServerSocket}.
+     * In addition, it supports the socket options specified by
+     * {@link RdmaSocketOptions}.
      *
      * <p> When binding the socket to an address, the socket address specified
      * to the {@code bind} method must correspond to the protocol family
@@ -140,10 +148,13 @@
      * SocketChannel#getLocalAddress() local address}, and not yet
      * {@link SocketChannel#isConnected() connected}.
      *
-     * <p> A socket channel to an RDMA socket supports all of the socket options
-     * specified by {@link SocketChannel java.nio.channels.SocketChannel}. In
-     * addition, it supports the socket options specified by
-     * {@link RdmaSocketOptions}.
+     * <p> A socket channel to an RDMA socket supports the socket options
+     * {@link java.net.StandardSocketOptions#SO_RCVBUF SO_RCVBUF},
+     * {@link java.net.StandardSocketOptions#SO_REUSEADDR SO_REUSEADDR},
+     * {@link java.net.StandardSocketOptions#SO_SNDBUF SO_SNDBUF}, and
+     * {@link java.net.StandardSocketOptions#TCP_NODELAY TCP_NODELAY}
+     * defined by {@link java.net.Socket java.net.Socket}. In addition,
+     * it supports the socket options specified by {@link RdmaSocketOptions}.
      *
      * <p> When binding the channel's socket to a local address, or invoking
      * {@code connect} to connect channel's socket, the socket address specified
@@ -174,6 +185,14 @@
      * channel is {@link SocketChannel#isOpen() open} but not yet bound to a
      * {@link SocketChannel#getLocalAddress() local address}.
      *
+     * <p> A server socket channel to an RDMA server socket supports the
+     * socket options
+     * {@link java.net.StandardSocketOptions#SO_RCVBUF SO_RCVBUF} and
+     * {@link java.net.StandardSocketOptions#SO_REUSEADDR SO_REUSEADDR}
+     * defined by {@link java.net.ServerSocket java.net.ServerSocket}.
+     * In addition, it supports the socket options specified by
+     * {@link RdmaSocketOptions}.
+     *
      * <p> When binding the channel's socket to an address, the socket address
      * specified to the {@code bind} method must correspond to the protocol
      * family specified here.