author | alanb |
Mon, 06 May 2019 09:43:26 +0100 | |
branch | niosocketimpl-branch |
changeset 57353 | ddfb12ab18e1 |
parent 57347 | 16c087c9103e |
child 57355 | ceb5c3fd71d2 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
54155
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
2 |
* Copyright (c) 1995, 2019, Oracle and/or its affiliates. All rights reserved. |
2 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
2 | 24 |
*/ |
25 |
||
26 |
package java.net; |
|
27 |
||
57173 | 28 |
import java.io.FileDescriptor; |
2 | 29 |
import java.io.IOException; |
30 |
import java.io.InputStream; |
|
31 |
import java.io.OutputStream; |
|
57174 | 32 |
import java.security.AccessController; |
33 |
import java.security.PrivilegedAction; |
|
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
34 |
import java.util.Set; |
2 | 35 |
|
57174 | 36 |
import sun.net.NetProperties; |
54155
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
37 |
import sun.net.PlatformSocketImpl; |
57167
82874527373e
Socket changes to support both NioSocketImpl and PlainSocketImpl switchable by net property
michaelm
parents:
47478
diff
changeset
|
38 |
import sun.nio.ch.NioSocketImpl; |
54155
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
39 |
|
2 | 40 |
/** |
19069 | 41 |
* The abstract class {@code SocketImpl} is a common superclass |
2 | 42 |
* of all classes that actually implement sockets. It is used to |
43 |
* create both client and server sockets. |
|
57275
222fa5ed1c91
Add @systemProperty ref to system property to configure old impl
alanb
parents:
57268
diff
changeset
|
44 |
* |
57353 | 45 |
* @implNote Client and server sockets created with the {@code Socket} and |
46 |
* {@code SocketServer} public constructors create a system/platform default |
|
47 |
* {@code SocketImpl}. The JDK historically used a {@code SocketImpl} |
|
48 |
* implementation type named "PlainSocketImpl" that has since been replaced by a |
|
49 |
* newer implementation. The JDK continues to ship with the older implementation |
|
50 |
* to allow code to run that depends on unspecified behavior that differs between |
|
51 |
* the old and new implementations. The old implementation will be used if the |
|
52 |
* Java virtual machine is started with the system property {@systemProperty |
|
53 |
* jdk.net.usePlainSocketImpl} set on the command line. It may also be set in |
|
54 |
* the JDK's network configuration file, located in {@code |
|
55 |
* ${java.home}/conf/net.properties}, for cases where it needs to be set without |
|
56 |
* changing the command line. The value of the system property is the string |
|
57 |
* representation of a boolean. If set without a value then it defaults to {@code |
|
58 |
* true}, hence running with {@code -Djdk.net.usePlainSocketImpl} or {@code |
|
59 |
* -Djdk.net.usePlainSocketImpl=true} will configure the Java virtual machine |
|
60 |
* to use the old implementation. |
|
2 | 61 |
* |
62 |
* @author unascribed |
|
24865
09b1d992ca72
8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents:
24046
diff
changeset
|
63 |
* @since 1.0 |
2 | 64 |
*/ |
65 |
public abstract class SocketImpl implements SocketOptions { |
|
57173 | 66 |
private static final boolean USE_PLAINSOCKETIMPL = usePlainSocketImpl(); |
67 |
||
68 |
private static boolean usePlainSocketImpl() { |
|
57177
0b5ebb227a8d
-Djdk.net.usePlainSocketImpl without value should use PlainSocketImpl
alanb
parents:
57176
diff
changeset
|
69 |
PrivilegedAction<String> pa = () -> NetProperties.get("jdk.net.usePlainSocketImpl"); |
0b5ebb227a8d
-Djdk.net.usePlainSocketImpl without value should use PlainSocketImpl
alanb
parents:
57176
diff
changeset
|
70 |
String s = AccessController.doPrivileged(pa); |
0b5ebb227a8d
-Djdk.net.usePlainSocketImpl without value should use PlainSocketImpl
alanb
parents:
57176
diff
changeset
|
71 |
return (s != null) && !s.equalsIgnoreCase("false"); |
57173 | 72 |
} |
54155
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
73 |
|
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
74 |
/** |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
75 |
* Creates an instance of platform's SocketImpl |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
76 |
*/ |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
77 |
@SuppressWarnings("unchecked") |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
78 |
static <S extends SocketImpl & PlatformSocketImpl> S createPlatformSocketImpl(boolean server) { |
57173 | 79 |
if (USE_PLAINSOCKETIMPL) { |
57347 | 80 |
return (S) new PlainSocketImpl(server); |
57173 | 81 |
} else { |
57178
738431fa8fb2
Improve clarity of implAccept, align timeout messages with PSI
alanb
parents:
57177
diff
changeset
|
82 |
return (S) new NioSocketImpl(server); |
57173 | 83 |
} |
54155
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
84 |
} |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
85 |
|
2 | 86 |
/** |
87 |
* The file descriptor object for this socket. |
|
88 |
*/ |
|
89 |
protected FileDescriptor fd; |
|
90 |
||
91 |
/** |
|
92 |
* The IP address of the remote end of this socket. |
|
93 |
*/ |
|
94 |
protected InetAddress address; |
|
95 |
||
96 |
/** |
|
97 |
* The port number on the remote host to which this socket is connected. |
|
98 |
*/ |
|
99 |
protected int port; |
|
100 |
||
101 |
/** |
|
102 |
* The local port number to which this socket is connected. |
|
103 |
*/ |
|
104 |
protected int localport; |
|
105 |
||
106 |
/** |
|
54689
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
107 |
* Whether this is a server or not. |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
108 |
*/ |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
109 |
final boolean isServer; |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
110 |
|
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
111 |
|
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
112 |
SocketImpl(boolean isServer) { |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
113 |
this.isServer = isServer; |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
114 |
} |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
115 |
|
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
116 |
/** |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
117 |
* Initialize a new instance of this class |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
118 |
*/ |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
119 |
public SocketImpl() { |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
120 |
this.isServer = false; |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
121 |
} |
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
122 |
|
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
123 |
/** |
2 | 124 |
* Creates either a stream or a datagram socket. |
125 |
* |
|
19069 | 126 |
* @param stream if {@code true}, create a stream socket; |
2 | 127 |
* otherwise, create a datagram socket. |
128 |
* @exception IOException if an I/O error occurs while creating the |
|
129 |
* socket. |
|
130 |
*/ |
|
131 |
protected abstract void create(boolean stream) throws IOException; |
|
132 |
||
133 |
/** |
|
134 |
* Connects this socket to the specified port on the named host. |
|
135 |
* |
|
136 |
* @param host the name of the remote host. |
|
137 |
* @param port the port number. |
|
138 |
* @exception IOException if an I/O error occurs when connecting to the |
|
139 |
* remote host. |
|
140 |
*/ |
|
141 |
protected abstract void connect(String host, int port) throws IOException; |
|
142 |
||
143 |
/** |
|
144 |
* Connects this socket to the specified port number on the specified host. |
|
145 |
* |
|
146 |
* @param address the IP address of the remote host. |
|
147 |
* @param port the port number. |
|
148 |
* @exception IOException if an I/O error occurs when attempting a |
|
149 |
* connection. |
|
150 |
*/ |
|
151 |
protected abstract void connect(InetAddress address, int port) throws IOException; |
|
152 |
||
153 |
/** |
|
154 |
* Connects this socket to the specified port number on the specified host. |
|
155 |
* A timeout of zero is interpreted as an infinite timeout. The connection |
|
156 |
* will then block until established or an error occurs. |
|
157 |
* |
|
158 |
* @param address the Socket address of the remote host. |
|
159 |
* @param timeout the timeout value, in milliseconds, or zero for no timeout. |
|
160 |
* @exception IOException if an I/O error occurs when attempting a |
|
161 |
* connection. |
|
162 |
* @since 1.4 |
|
163 |
*/ |
|
164 |
protected abstract void connect(SocketAddress address, int timeout) throws IOException; |
|
165 |
||
166 |
/** |
|
167 |
* Binds this socket to the specified local IP address and port number. |
|
168 |
* |
|
169 |
* @param host an IP address that belongs to a local interface. |
|
170 |
* @param port the port number. |
|
171 |
* @exception IOException if an I/O error occurs when binding this socket. |
|
172 |
*/ |
|
173 |
protected abstract void bind(InetAddress host, int port) throws IOException; |
|
174 |
||
175 |
/** |
|
176 |
* Sets the maximum queue length for incoming connection indications |
|
19069 | 177 |
* (a request to connect) to the {@code count} argument. If a |
2 | 178 |
* connection indication arrives when the queue is full, the |
179 |
* connection is refused. |
|
180 |
* |
|
181 |
* @param backlog the maximum length of the queue. |
|
182 |
* @exception IOException if an I/O error occurs when creating the queue. |
|
183 |
*/ |
|
184 |
protected abstract void listen(int backlog) throws IOException; |
|
185 |
||
186 |
/** |
|
187 |
* Accepts a connection. |
|
188 |
* |
|
189 |
* @param s the accepted connection. |
|
190 |
* @exception IOException if an I/O error occurs when accepting the |
|
191 |
* connection. |
|
192 |
*/ |
|
193 |
protected abstract void accept(SocketImpl s) throws IOException; |
|
194 |
||
195 |
/** |
|
196 |
* Returns an input stream for this socket. |
|
197 |
* |
|
198 |
* @return a stream for reading from this socket. |
|
199 |
* @exception IOException if an I/O error occurs when creating the |
|
200 |
* input stream. |
|
201 |
*/ |
|
202 |
protected abstract InputStream getInputStream() throws IOException; |
|
203 |
||
204 |
/** |
|
205 |
* Returns an output stream for this socket. |
|
206 |
* |
|
207 |
* @return an output stream for writing to this socket. |
|
208 |
* @exception IOException if an I/O error occurs when creating the |
|
209 |
* output stream. |
|
210 |
*/ |
|
211 |
protected abstract OutputStream getOutputStream() throws IOException; |
|
212 |
||
213 |
/** |
|
214 |
* Returns the number of bytes that can be read from this socket |
|
215 |
* without blocking. |
|
216 |
* |
|
217 |
* @return the number of bytes that can be read from this socket |
|
218 |
* without blocking. |
|
219 |
* @exception IOException if an I/O error occurs when determining the |
|
220 |
* number of bytes available. |
|
221 |
*/ |
|
222 |
protected abstract int available() throws IOException; |
|
223 |
||
224 |
/** |
|
225 |
* Closes this socket. |
|
226 |
* |
|
227 |
* @exception IOException if an I/O error occurs when closing this socket. |
|
228 |
*/ |
|
229 |
protected abstract void close() throws IOException; |
|
230 |
||
231 |
/** |
|
54155
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
232 |
* Closes this socket, ignoring any IOException that is thrown by close. |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
233 |
*/ |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
234 |
void closeQuietly() { |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
235 |
try { |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
236 |
close(); |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
237 |
} catch (IOException ignore) { } |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
238 |
} |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
239 |
|
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
240 |
/** |
2 | 241 |
* Places the input stream for this socket at "end of stream". |
242 |
* Any data sent to this socket is acknowledged and then |
|
243 |
* silently discarded. |
|
244 |
* |
|
10421
2ee16a0f6df5
7014860: Socket.getInputStream().available() not clear for shutdown input
chegar
parents:
5506
diff
changeset
|
245 |
* If you read from a socket input stream after invoking this method on the |
2ee16a0f6df5
7014860: Socket.getInputStream().available() not clear for shutdown input
chegar
parents:
5506
diff
changeset
|
246 |
* socket, the stream's {@code available} method will return 0, and its |
2ee16a0f6df5
7014860: Socket.getInputStream().available() not clear for shutdown input
chegar
parents:
5506
diff
changeset
|
247 |
* {@code read} methods will return {@code -1} (end of stream). |
2 | 248 |
* |
249 |
* @exception IOException if an I/O error occurs when shutting down this |
|
250 |
* socket. |
|
251 |
* @see java.net.Socket#shutdownOutput() |
|
252 |
* @see java.net.Socket#close() |
|
253 |
* @see java.net.Socket#setSoLinger(boolean, int) |
|
254 |
* @since 1.3 |
|
255 |
*/ |
|
256 |
protected void shutdownInput() throws IOException { |
|
257 |
throw new IOException("Method not implemented!"); |
|
258 |
} |
|
259 |
||
260 |
/** |
|
261 |
* Disables the output stream for this socket. |
|
262 |
* For a TCP socket, any previously written data will be sent |
|
263 |
* followed by TCP's normal connection termination sequence. |
|
264 |
* |
|
265 |
* If you write to a socket output stream after invoking |
|
266 |
* shutdownOutput() on the socket, the stream will throw |
|
267 |
* an IOException. |
|
268 |
* |
|
269 |
* @exception IOException if an I/O error occurs when shutting down this |
|
270 |
* socket. |
|
271 |
* @see java.net.Socket#shutdownInput() |
|
272 |
* @see java.net.Socket#close() |
|
273 |
* @see java.net.Socket#setSoLinger(boolean, int) |
|
274 |
* @since 1.3 |
|
275 |
*/ |
|
276 |
protected void shutdownOutput() throws IOException { |
|
277 |
throw new IOException("Method not implemented!"); |
|
278 |
} |
|
279 |
||
280 |
/** |
|
19069 | 281 |
* Returns the value of this socket's {@code fd} field. |
2 | 282 |
* |
19069 | 283 |
* @return the value of this socket's {@code fd} field. |
2 | 284 |
* @see java.net.SocketImpl#fd |
285 |
*/ |
|
286 |
protected FileDescriptor getFileDescriptor() { |
|
287 |
return fd; |
|
288 |
} |
|
289 |
||
290 |
/** |
|
19069 | 291 |
* Returns the value of this socket's {@code address} field. |
2 | 292 |
* |
19069 | 293 |
* @return the value of this socket's {@code address} field. |
2 | 294 |
* @see java.net.SocketImpl#address |
295 |
*/ |
|
296 |
protected InetAddress getInetAddress() { |
|
297 |
return address; |
|
298 |
} |
|
299 |
||
300 |
/** |
|
19069 | 301 |
* Returns the value of this socket's {@code port} field. |
2 | 302 |
* |
19069 | 303 |
* @return the value of this socket's {@code port} field. |
2 | 304 |
* @see java.net.SocketImpl#port |
305 |
*/ |
|
306 |
protected int getPort() { |
|
307 |
return port; |
|
308 |
} |
|
309 |
||
310 |
/** |
|
311 |
* Returns whether or not this SocketImpl supports sending |
|
312 |
* urgent data. By default, false is returned |
|
313 |
* unless the method is overridden in a sub-class |
|
314 |
* |
|
315 |
* @return true if urgent data supported |
|
316 |
* @see java.net.SocketImpl#address |
|
317 |
* @since 1.4 |
|
318 |
*/ |
|
319 |
protected boolean supportsUrgentData () { |
|
320 |
return false; // must be overridden in sub-class |
|
321 |
} |
|
322 |
||
323 |
/** |
|
324 |
* Send one byte of urgent data on the socket. |
|
325 |
* The byte to be sent is the low eight bits of the parameter |
|
326 |
* @param data The byte of data to send |
|
327 |
* @exception IOException if there is an error |
|
328 |
* sending the data. |
|
329 |
* @since 1.4 |
|
330 |
*/ |
|
331 |
protected abstract void sendUrgentData (int data) throws IOException; |
|
332 |
||
333 |
/** |
|
19069 | 334 |
* Returns the value of this socket's {@code localport} field. |
2 | 335 |
* |
19069 | 336 |
* @return the value of this socket's {@code localport} field. |
2 | 337 |
* @see java.net.SocketImpl#localport |
338 |
*/ |
|
339 |
protected int getLocalPort() { |
|
340 |
return localport; |
|
341 |
} |
|
342 |
||
343 |
/** |
|
19069 | 344 |
* Returns the address and port of this socket as a {@code String}. |
2 | 345 |
* |
346 |
* @return a string representation of this socket. |
|
347 |
*/ |
|
348 |
public String toString() { |
|
349 |
return "Socket[addr=" + getInetAddress() + |
|
350 |
",port=" + getPort() + ",localport=" + getLocalPort() + "]"; |
|
351 |
} |
|
352 |
||
54155
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
353 |
void reset() { |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
354 |
fd = null; |
2 | 355 |
address = null; |
356 |
port = 0; |
|
357 |
localport = 0; |
|
358 |
} |
|
359 |
||
360 |
/** |
|
361 |
* Sets performance preferences for this socket. |
|
362 |
* |
|
363 |
* <p> Sockets use the TCP/IP protocol by default. Some implementations |
|
364 |
* may offer alternative protocols which have different performance |
|
365 |
* characteristics than TCP/IP. This method allows the application to |
|
366 |
* express its own preferences as to how these tradeoffs should be made |
|
367 |
* when the implementation chooses from the available protocols. |
|
368 |
* |
|
369 |
* <p> Performance preferences are described by three integers |
|
370 |
* whose values indicate the relative importance of short connection time, |
|
371 |
* low latency, and high bandwidth. The absolute values of the integers |
|
372 |
* are irrelevant; in order to choose a protocol the values are simply |
|
373 |
* compared, with larger values indicating stronger preferences. Negative |
|
374 |
* values represent a lower priority than positive values. If the |
|
375 |
* application prefers short connection time over both low latency and high |
|
376 |
* bandwidth, for example, then it could invoke this method with the values |
|
19069 | 377 |
* {@code (1, 0, 0)}. If the application prefers high bandwidth above low |
2 | 378 |
* latency, and low latency above short connection time, then it could |
19069 | 379 |
* invoke this method with the values {@code (0, 1, 2)}. |
2 | 380 |
* |
47478 | 381 |
* By default, this method does nothing, unless it is overridden in |
2 | 382 |
* a sub-class. |
383 |
* |
|
384 |
* @param connectionTime |
|
19069 | 385 |
* An {@code int} expressing the relative importance of a short |
2 | 386 |
* connection time |
387 |
* |
|
388 |
* @param latency |
|
19069 | 389 |
* An {@code int} expressing the relative importance of low |
2 | 390 |
* latency |
391 |
* |
|
392 |
* @param bandwidth |
|
19069 | 393 |
* An {@code int} expressing the relative importance of high |
2 | 394 |
* bandwidth |
395 |
* |
|
396 |
* @since 1.5 |
|
397 |
*/ |
|
398 |
protected void setPerformancePreferences(int connectionTime, |
|
399 |
int latency, |
|
400 |
int bandwidth) |
|
401 |
{ |
|
402 |
/* Not implemented yet */ |
|
403 |
} |
|
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
404 |
|
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
405 |
/** |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
406 |
* Called to set a socket option. |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
407 |
* |
28852
a581c7868768
8041395: Doclint regression in java.net.SocketOption
darcy
parents:
27341
diff
changeset
|
408 |
* @param <T> The type of the socket option value |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
409 |
* @param name The socket option |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
410 |
* |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
411 |
* @param value The value of the socket option. A value of {@code null} |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
412 |
* may be valid for some options. |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
413 |
* |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
414 |
* @throws UnsupportedOperationException if the SocketImpl does not |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
415 |
* support the option |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
416 |
* |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
417 |
* @throws IOException if an I/O error occurs, or if the socket is closed. |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
418 |
* |
35302
e4d2275861c3
8136494: Update "@since 1.9" to "@since 9" to match java.version.specification
iris
parents:
34968
diff
changeset
|
419 |
* @since 9 |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
420 |
*/ |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
421 |
protected <T> void setOption(SocketOption<T> name, T value) throws IOException { |
54689
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
422 |
if (name == StandardSocketOptions.SO_KEEPALIVE && !isServer) { |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
423 |
setOption(SocketOptions.SO_KEEPALIVE, value); |
54689
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
424 |
} else if (name == StandardSocketOptions.SO_SNDBUF && !isServer) { |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
425 |
setOption(SocketOptions.SO_SNDBUF, value); |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
426 |
} else if (name == StandardSocketOptions.SO_RCVBUF) { |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
427 |
setOption(SocketOptions.SO_RCVBUF, value); |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
428 |
} else if (name == StandardSocketOptions.SO_REUSEADDR) { |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
429 |
setOption(SocketOptions.SO_REUSEADDR, value); |
36115 | 430 |
} else if (name == StandardSocketOptions.SO_REUSEPORT && |
431 |
supportedOptions().contains(name)) { |
|
432 |
setOption(SocketOptions.SO_REUSEPORT, value); |
|
54689
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
433 |
} else if (name == StandardSocketOptions.SO_LINGER && !isServer) { |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
434 |
setOption(SocketOptions.SO_LINGER, value); |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
435 |
} else if (name == StandardSocketOptions.IP_TOS) { |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
436 |
setOption(SocketOptions.IP_TOS, value); |
54689
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
437 |
} else if (name == StandardSocketOptions.TCP_NODELAY && !isServer) { |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
438 |
setOption(SocketOptions.TCP_NODELAY, value); |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
439 |
} else { |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
440 |
throw new UnsupportedOperationException("unsupported option"); |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
441 |
} |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
442 |
} |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
443 |
|
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
444 |
/** |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
445 |
* Called to get a socket option. |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
446 |
* |
28852
a581c7868768
8041395: Doclint regression in java.net.SocketOption
darcy
parents:
27341
diff
changeset
|
447 |
* @param <T> The type of the socket option value |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
448 |
* @param name The socket option |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
449 |
* |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
450 |
* @return the value of the named option |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
451 |
* |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
452 |
* @throws UnsupportedOperationException if the SocketImpl does not |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
453 |
* support the option. |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
454 |
* |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
455 |
* @throws IOException if an I/O error occurs, or if the socket is closed. |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
456 |
* |
35302
e4d2275861c3
8136494: Update "@since 1.9" to "@since 9" to match java.version.specification
iris
parents:
34968
diff
changeset
|
457 |
* @since 9 |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
458 |
*/ |
24046
d1f6da65881a
8041397: Lint regression in java.net.SocketOption
michaelm
parents:
23879
diff
changeset
|
459 |
@SuppressWarnings("unchecked") |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
460 |
protected <T> T getOption(SocketOption<T> name) throws IOException { |
54689
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
461 |
if (name == StandardSocketOptions.SO_KEEPALIVE && !isServer) { |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
462 |
return (T)getOption(SocketOptions.SO_KEEPALIVE); |
54689
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
463 |
} else if (name == StandardSocketOptions.SO_SNDBUF && !isServer) { |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
464 |
return (T)getOption(SocketOptions.SO_SNDBUF); |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
465 |
} else if (name == StandardSocketOptions.SO_RCVBUF) { |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
466 |
return (T)getOption(SocketOptions.SO_RCVBUF); |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
467 |
} else if (name == StandardSocketOptions.SO_REUSEADDR) { |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
468 |
return (T)getOption(SocketOptions.SO_REUSEADDR); |
36115 | 469 |
} else if (name == StandardSocketOptions.SO_REUSEPORT && |
470 |
supportedOptions().contains(name)) { |
|
471 |
return (T)getOption(SocketOptions.SO_REUSEPORT); |
|
54689
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
472 |
} else if (name == StandardSocketOptions.SO_LINGER && !isServer) { |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
473 |
return (T)getOption(SocketOptions.SO_LINGER); |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
474 |
} else if (name == StandardSocketOptions.IP_TOS) { |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
475 |
return (T)getOption(SocketOptions.IP_TOS); |
54689
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
476 |
} else if (name == StandardSocketOptions.TCP_NODELAY && !isServer) { |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
477 |
return (T)getOption(SocketOptions.TCP_NODELAY); |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
478 |
} else { |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
479 |
throw new UnsupportedOperationException("unsupported option"); |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
480 |
} |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
481 |
} |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
482 |
|
54155
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
483 |
/** |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
484 |
* Attempts to copy socket options from this SocketImpl to a target SocketImpl. |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
485 |
* At this time, only the SO_TIMEOUT make sense to copy. |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
486 |
*/ |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
487 |
void copyOptionsTo(SocketImpl target) { |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
488 |
try { |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
489 |
Object timeout = getOption(SocketOptions.SO_TIMEOUT); |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
490 |
if (timeout instanceof Integer) { |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
491 |
target.setOption(SocketOptions.SO_TIMEOUT, timeout); |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
492 |
} |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
493 |
} catch (IOException ignore) { } |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
494 |
} |
b5a73f22b2bd
8220493: Prepare Socket/ServerSocket for alternative platform SocketImpl
alanb
parents:
47478
diff
changeset
|
495 |
|
36228
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
496 |
private static final Set<SocketOption<?>> socketOptions; |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
497 |
|
36228
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
498 |
private static final Set<SocketOption<?>> serverSocketOptions; |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
499 |
|
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
500 |
static { |
36228
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
501 |
socketOptions = Set.of(StandardSocketOptions.SO_KEEPALIVE, |
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
502 |
StandardSocketOptions.SO_SNDBUF, |
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
503 |
StandardSocketOptions.SO_RCVBUF, |
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
504 |
StandardSocketOptions.SO_REUSEADDR, |
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
505 |
StandardSocketOptions.SO_LINGER, |
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
506 |
StandardSocketOptions.IP_TOS, |
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
507 |
StandardSocketOptions.TCP_NODELAY); |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
508 |
|
36228
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
509 |
serverSocketOptions = Set.of(StandardSocketOptions.SO_RCVBUF, |
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
510 |
StandardSocketOptions.SO_REUSEADDR, |
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
511 |
StandardSocketOptions.IP_TOS); |
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
512 |
} |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
513 |
|
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
514 |
/** |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
515 |
* Returns a set of SocketOptions supported by this impl |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
516 |
* and by this impl's socket (Socket or ServerSocket) |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
517 |
* |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
518 |
* @return a Set of SocketOptions |
36228
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
519 |
* |
a16a22218e23
8148609: socket impl supportedOptions() should return an immutable set
vtewari
parents:
36115
diff
changeset
|
520 |
* @since 9 |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
521 |
*/ |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
522 |
protected Set<SocketOption<?>> supportedOptions() { |
54689
b28b7f631301
8216978: Drop support for pre JDK 1.4 SocketImpl implementations
michaelm
parents:
54155
diff
changeset
|
523 |
if (!isServer) { |
23879
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
524 |
return socketOptions; |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
525 |
} else { |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
526 |
return serverSocketOptions; |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
527 |
} |
284802a2d355
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
19069
diff
changeset
|
528 |
} |
2 | 529 |
} |