パッケージ org.springframework.web.reactive.socket.client

クラス UndertowWebSocketClient

java.lang.ObjectSE
org.springframework.web.reactive.socket.client.UndertowWebSocketClient
実装されたすべてのインターフェース:
WebSocketClient
public class UndertowWebSocketClient extends ObjectSE implements WebSocketClient
WebSocketClient の Undertow ベースの実装。
導入:
5.0
作成者:
Violeta Georgieva, Rossen Stoyanchev

  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    UndertowWebSocketClient(org.xnio.XnioWorker worker)
    WebSocketClient.connectionBuilder(org.xnio.XnioWorker, io.undertow.connector.ByteBufferPool, java.net.URI) に渡す XnioWorker を含むコンストラクター。
    UndertowWebSocketClient(org.xnio.XnioWorker worker, io.undertow.connector.ByteBufferPool byteBufferPool, ConsumerSE<io.undertow.websockets.client.WebSocketClient.ConnectionBuilder> builderConsumer)
    各 WebSocket 接続の WebSocketClient.ConnectionBuilder に対する追加の制御を提供する代替コンストラクター。
    UndertowWebSocketClient(org.xnio.XnioWorker worker, ConsumerSE<io.undertow.websockets.client.WebSocketClient.ConnectionBuilder> builderConsumer)
    各 WebSocket 接続の WebSocketClient.ConnectionBuilder に対する追加の制御を提供する代替コンストラクター。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    protected io.undertow.websockets.client.WebSocketClient.ConnectionBuilder
    createConnectionBuilder(URISE url)
    指定された URI の WebSocketClient.ConnectionBuilder を作成します。
    reactor.core.publisher.Mono<VoidSE>
    execute(URISE url, HttpHeaders headers, WebSocketHandler handler)
    カスタムヘッダーを持つ WebSocketClient.execute(URI, WebSocketHandler) のバリアント。
    reactor.core.publisher.Mono<VoidSE>
    execute(URISE url, WebSocketHandler handler)
    指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。
    io.undertow.connector.ByteBufferPool
    getByteBufferPool()
    このクライアントが新しく作成した WebSocket セッションに現在使用されている ByteBufferPool を返します。
    ConsumerSE<io.undertow.websockets.client.WebSocketClient.ConnectionBuilder>
    getConnectionBuilderConsumer()
    設定された Consumer<ConnectionBuilder> を返します。
    org.xnio.XnioWorker
    getXnioWorker()
    設定された XnioWorker を返します。
    void
    setByteBufferPool(io.undertow.connector.ByteBufferPool byteBufferPool)
    ByteBufferPool を WebSocketClient.connectionBuilder(org.xnio.XnioWorker, io.undertow.connector.ByteBufferPool, java.net.URI) に渡すように設定します。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • コンストラクターの詳細

    • UndertowWebSocketClient

      public UndertowWebSocketClient(org.xnio.XnioWorker worker)
      WebSocketClient.connectionBuilder(org.xnio.XnioWorker, io.undertow.connector.ByteBufferPool, java.net.URI) に渡す XnioWorker を含むコンストラクター。
      パラメーター:
      worker - Xnio ワーカー

    • UndertowWebSocketClient

      public UndertowWebSocketClient(org.xnio.XnioWorker worker, ConsumerSE<io.undertow.websockets.client.WebSocketClient.ConnectionBuilder> builderConsumer)
      各 WebSocket 接続の WebSocketClient.ConnectionBuilder に対する追加の制御を提供する代替コンストラクター。
      パラメーター:
      worker - ConnectionBuilder の作成に使用する Xnio ワーカー
      builderConsumer - ConnectionBuilder を構成するコンシューマー

    • UndertowWebSocketClient

      public UndertowWebSocketClient(org.xnio.XnioWorker worker, io.undertow.connector.ByteBufferPool byteBufferPool, ConsumerSE<io.undertow.websockets.client.WebSocketClient.ConnectionBuilder> builderConsumer)
      各 WebSocket 接続の WebSocketClient.ConnectionBuilder に対する追加の制御を提供する代替コンストラクター。
      パラメーター:
      worker - ConnectionBuilder の作成に使用する Xnio ワーカー
      byteBufferPool - ConnectionBuilder の作成に使用する ByteBufferPool
      builderConsumer - ConnectionBuilder を構成するコンシューマー
      導入:
      5.0.8

  • メソッドの詳細

    • getXnioWorker

      public org.xnio.XnioWorker getXnioWorker()
      設定された XnioWorker を返します。

    • setByteBufferPool

      public void setByteBufferPool(io.undertow.connector.ByteBufferPool byteBufferPool)
      ByteBufferPool を WebSocketClient.connectionBuilder(org.xnio.XnioWorker, io.undertow.connector.ByteBufferPool, java.net.URI) に渡すように設定します。

      デフォルトでは、バッファサイズ 8192 の間接 DefaultByteBufferPool が使用されます。

      導入:
      5.0.8
      関連事項:
      • DEFAULT_POOL_BUFFER_SIZE

    • getByteBufferPool

      public io.undertow.connector.ByteBufferPool getByteBufferPool()
      このクライアントが新しく作成した WebSocket セッションに現在使用されている ByteBufferPool を返します。
      戻り値:
      バイトバッファプール
      導入:
      5.0.8

    • getConnectionBuilderConsumer

      public ConsumerSE<io.undertow.websockets.client.WebSocketClient.ConnectionBuilder> getConnectionBuilderConsumer()
      設定された Consumer<ConnectionBuilder> を返します。

    • execute

      public reactor.core.publisher.Mono<VoidSE> execute(URISE url, WebSocketHandler handler)
      インターフェースからコピーされた説明: WebSocketClient
      指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。
      次で指定:
      インターフェース WebSocketClient の execute 
      パラメーター:
      url - ハンドシェイク URL
      handler - WebSocket セッションのハンドラー
      戻り値:
      WebSocket セッション処理の結果を示す Mono<Void> の補完。

    • execute

      public reactor.core.publisher.Mono<VoidSE> execute(URISE url, HttpHeaders headers, WebSocketHandler handler)
      インターフェースからコピーされた説明: WebSocketClient
      カスタムヘッダーを持つ WebSocketClient.execute(URI, WebSocketHandler) のバリアント。
      次で指定:
      インターフェース WebSocketClient の execute 
      パラメーター:
      url - ハンドシェイク URL
      headers - ハンドシェイクリクエストのカスタムヘッダー
      handler - WebSocket セッションのハンドラー
      戻り値:
      WebSocket セッション処理の結果を示す Mono<Void> の補完。

    • createConnectionBuilder

      protected io.undertow.websockets.client.WebSocketClient.ConnectionBuilder createConnectionBuilder(URISE url)
      指定された URI の WebSocketClient.ConnectionBuilder を作成します。

      デフォルトの実装では、構成済みの XnioWorker および ByteBufferPool を使用してビルダーを作成し、構築時に提供される consumer に渡します。