-
- Enclosing interface:
- WebSocket
public static interface WebSocket.Builder
WebSocket Clients的生成器 。通过调用
HttpClient.newWebSocketBuilder
创建构建器 。 中间(类似setter)方法更改构建器的状态并返回它们已调用的相同构建器。 如果未调用中间方法,则将假定适当的默认值(或行为)。 没有外部同步的多线程使用Builder
是不安全的。- 从以下版本开始:
- 11
-
-
方法摘要
所有方法 实例方法 抽象方法 变量和类型 方法 描述 CompletableFuture<WebSocket>
buildAsync(URI uri, WebSocket.Listener listener)
建立一个WebSocket
连接到给定的URI
,并与给定的相关联Listener
。WebSocket.Builder
connectTimeout(Duration timeout)
设置建立WebSocket连接的超时。WebSocket.Builder
header(String name, String value)
将给定的名称 - 值对添加到打开握手期间发送的其他HTTP标头的列表中。WebSocket.Builder
subprotocols(String mostPreferred, String... lesserPreferred)
设置给定子协议的请求。
-
-
-
方法详细信息
-
header
WebSocket.Builder header(String name, String value)
将给定的名称 - 值对添加到打开握手期间发送的其他HTTP标头的列表中。WebSocket Protocol中定义的标头是非法的。 如果未调用此方法,则不会发送其他HTTP标头。
- 参数
-
name
- 标题名称 -
value
- 标头值 - 结果
- 这个建设者
-
connectTimeout
WebSocket.Builder connectTimeout(Duration timeout)
设置建立WebSocket连接的超时。如果未在指定的持续时间内建立连接,则
WebSocket
将失败并显示HttpTimeoutException
。 如果未调用此方法,则假定为无限超时。
-
subprotocols
WebSocket.Builder subprotocols(String mostPreferred, String... lesserPreferred)
设置给定子协议的请求。构建
WebSocket
后,可以通过WebSocket.getSubprotocol()
查询实际的子协议 。子协议按优先顺序指定。 首先指定最优选的子协议。 如果有任何其他子协议,则从最优选到最不优选列举它们。
不符合子协议标识符语法的子协议是非法的。 如果未调用此方法,则不会请求子协议。
- 参数
-
mostPreferred
- 最优选的子协议 -
lesserPreferred
- 较不优选的子协议 - 结果
- 这个建设者
-
buildAsync
CompletableFuture<WebSocket> buildAsync(URI uri, WebSocket.Listener listener)
建立一个WebSocket
连接到给定的URI
,并与给定的相关联Listener
。返回
CompletableFuture
,它将使用生成的WebSocket
正常完成,或者异常完成,并出现以下错误之一:-
IOException
- 如果发生I / O错误 -
WebSocketHandshakeException
- 如果打开握手失败 -
HttpTimeoutException
- 如果打开握手未在超时内完成 -
InterruptedException
- 如果操作中断 -
SecurityException
- 如果已安装安全管理器,则拒绝access
至uri
。 Security checks包含有关调用侦听器的安全上下文的更多信息。 -
IllegalArgumentException
- 如果此构建器方法的任何参数是非法的
- 参数
-
uri
- WebSocket URI -
listener
- 听众 - 结果
-
CompletableFuture
与WebSocket
-
-
-