モジュール java.net.http
パッケージ java.net.http

インタフェースWebSocket.Builder

含まれているインタフェース:
WebSocket
public static interface WebSocket.Builder
「WebSocketクライアント」のビルダー。

ビルダーは、HttpClient.newWebSocketBuilderを呼び出すことによって作成されます。 中間の(setter-like)メソッドは、ビルダーの状態を変更し、起動されたのと同じビルダーを返します。 中間メソッドが起動されない場合、適切なデフォルト値(または行動)が使用されます。 Builderは、外部同期化のない複数のスレッドでは安全ではありません。

導入されたバージョン:
11

  • メソッドの詳細

    • 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