WebSocket
public static interface WebSocket.Builder
Builders are created by invoking HttpClient.newWebSocketBuilder
. The intermediate (setter-like) methods change the state of the builder and return the same builder they have been invoked on. If an intermediate method is not invoked, an appropriate default value (or behavior) will be assumed. A Builder
is not safe for use by multiple threads without external synchronization.
Modifier and Type | Method | Description |
---|---|---|
CompletableFuture |
buildAsync |
|
WebSocket.Builder |
connectTimeout |
Sets a timeout for establishing a WebSocket connection. |
WebSocket.Builder |
header |
Adds the given name-value pair to the list of additional HTTP headers sent during the opening handshake. |
WebSocket.Builder |
subprotocols |
Sets a request for the given subprotocols. |
WebSocket.Builder header(String name, String value)
Headers defined in the WebSocket Protocol are illegal. If this method is not invoked, no additional HTTP headers will be sent.
name
- the header namevalue
- the header valueWebSocket.Builder connectTimeout(Duration timeout)
If the connection is not established within the specified duration then building of the WebSocket
will fail with HttpTimeoutException
. If this method is not invoked then the infinite timeout is assumed.
WebSocket.Builder subprotocols(String mostPreferred, String... lesserPreferred)
After the WebSocket
has been built, the actual subprotocol can be queried through WebSocket.getSubprotocol()
.
Subprotocols are specified in the order of preference. The most preferred subprotocol is specified first. If there are any additional subprotocols they are enumerated from the most preferred to the least preferred.
Subprotocols not conforming to the syntax of subprotocol identifiers are illegal. If this method is not invoked then no subprotocols will be requested.
mostPreferred
- the most preferred subprotocollesserPreferred
- the lesser preferred subprotocolsCompletableFuture<WebSocket> buildAsync(URI uri, WebSocket.Listener listener)
WebSocket
connected to the given URI
and associated with the given Listener
. Returns a CompletableFuture
which will either complete normally with the resulting WebSocket
or complete exceptionally with one of the following errors:
IOException
- if an I/O error occurs WebSocketHandshakeException
- if the opening handshake fails HttpTimeoutException
- if the opening handshake does not complete within the timeout InterruptedException
- if the operation is interrupted SecurityException
- if a security manager has been installed and it denies access
to uri
. Security checks contains more information relating to the security context in which the listener is invoked. IllegalArgumentException
- if any of the arguments of this builder's methods are illegal uri
- the WebSocket URIlistener
- the listenerCompletableFuture
with the WebSocket
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.net.http/java/net/http/WebSocket.Builder.html