模块  java.net.http
软件包  java.net.http

Interface WebSocket.Builder

  • Enclosing interface:
    WebSocket

    public static interface WebSocket.Builder
    WebSocket Clients的生成器

    通过调用HttpClient.newWebSocketBuilder创建构建器 中间(类似setter)方法更改构建器的状态并返回它们已调用的相同构建器。 如果未调用中间方法,则将假定适当的默认值(或行为)。 没有外部同步的多线程使用Builder是不安全的。

    从以下版本开始:
    11
    • 方法详细信息

      • header

        WebSocket.Builder header​(String name,
                                 String value)
        将给定的名称 - 值对添加到打开握手期间发送的其他HTTP标头的列表中。

        WebSocket Protocol中定义的头是非法的。 如果未调用此方法,则不会发送其他HTTP标头。

        参数
        name - 标题名称
        value - 标头值
        结果
        这个建设者
      • connectTimeout

        WebSocket.Builder connectTimeout​(Duration timeout)
        设置建立WebSocket连接的超时。

        如果未在指定的持续时间内建立连接,则WebSocket将失败并显示HttpTimeoutException 如果未调用此方法,则假定为无限超时。

        参数
        timeout - 超时,非 negative ,非 ZERO
        结果
        这个建设者
      • subprotocols

        WebSocket.Builder subprotocols​(String mostPreferred,
                                       String... lesserPreferred)
        设置给定子协议的请求。

        构建WebSocket后,可以通过WebSocket.getSubprotocol()查询实际的子协议

        子协议按优先顺序指定。 首先指定最优选的子协议。 如果有任何其他子协议,则从最优选到最不优选列举它们。

        不符合子协议标识符语法的子协议是非法的。 如果未调用此方法,则不会请求子协议。

        参数
        mostPreferred - 最优选的子协议
        lesserPreferred - 较不优选的子协议
        结果
        这个建设者