モジュール jdk.incubator.httpclient
パッケージ jdk.incubator.http

インタフェースWebSocket.Builder

  • 含まれているインタフェース:
    WebSocket

    public static interface WebSocket.Builder
    WebSocketインスタンスを作成するためのビルダー。
    インキュベーション機能。将来のリリースで削除されます。

    WebSocketを取得するには、必要に応じて中間メソッド(ビルダー自体を返すもの)を呼び出してビルダーを構成し、buildAsync()を呼び出します。 中間メソッドが呼び出されない場合、適切なデフォルト値(または行動)が仮定されます。

    特に指定のない限り、null引数はBuilderのメソッドにNullPointerExceptionをスローさせます。

    導入されたバージョン:
    9
    • メソッドの詳細

      • header

        WebSocket.Builder header​(String name,
                                 String value)
        指定された名前と値のペアを、オープニング・ハンドシェイク中に送信された追加のHTTPヘッダーのリストに追加します。

        WebSocketプロトコルで定義されたヘッダーは不正です。 このメソッドが呼び出されない場合、追加の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 - あまり好ましくないサブ・プロトコル
        戻り値:
        このビルダー
      • buildAsync

        CompletableFuture<WebSocket> buildAsync​(URI uri,
                                                WebSocket.Listener listener)
        指定されたURIに接続され、指定されたListenerに関連付けられたWebSocketを構築します。

        CompletableFutureを返します。CompletableFutureは、結果として得られるWebSocketで正常に完了するか、例外的に次のエラーのいずれかで完了します:

        パラメータ:
        uri - WebSocket URI
        listener - リスナー
        戻り値:
        WebSocketを含むCompletableFuture