类 UndertowWebSocketClient

构造器详细资料

• UndertowWebSocketClient

  public UndertowWebSocketClient​(XnioWorker worker)

  Constructor with the XnioWorker to pass to WebSocketClient.connectionBuilder(org.xnio.XnioWorker, io.undertow.connector.ByteBufferPool, java.net.URI).

  参数:

  worker - the Xnio worker

• UndertowWebSocketClient

  public UndertowWebSocketClient​(XnioWorker worker,
                                 Consumer<io.undertow.websockets.client.WebSocketClient.ConnectionBuilder> builderConsumer)

  Alternate constructor providing additional control over the WebSocketClient.ConnectionBuilder for each WebSocket connection.

  参数:

  worker - the Xnio worker to use to create ConnectionBuilder's

  builderConsumer - a consumer to configure ConnectionBuilder's

• UndertowWebSocketClient

  public UndertowWebSocketClient​(XnioWorker worker,
                                 io.undertow.connector.ByteBufferPool byteBufferPool,
                                 Consumer<io.undertow.websockets.client.WebSocketClient.ConnectionBuilder> builderConsumer)

  Alternate constructor providing additional control over the WebSocketClient.ConnectionBuilder for each WebSocket connection.

  参数:

  worker - the Xnio worker to use to create ConnectionBuilder's

  byteBufferPool - the ByteBufferPool to use to create ConnectionBuilder's

  builderConsumer - a consumer to configure ConnectionBuilder's

  从以下版本开始:

  5.0.8

方法详细资料

• getXnioWorker

  public XnioWorker getXnioWorker()

  Return the configured XnioWorker.

• setByteBufferPool

  public void setByteBufferPool​(io.undertow.connector.ByteBufferPool byteBufferPool)

  Set the ByteBufferPool to pass to WebSocketClient.connectionBuilder(org.xnio.XnioWorker, io.undertow.connector.ByteBufferPool, java.net.URI).

  By default an indirect DefaultByteBufferPool with a buffer size of 8192 is used.

  从以下版本开始:

  5.0.8

  另请参阅:

  DEFAULT_POOL_BUFFER_SIZE

• getByteBufferPool

  public io.undertow.connector.ByteBufferPool getByteBufferPool()

  Return the ByteBufferPool currently used for newly created WebSocket sessions by this client.

  返回:

  the byte buffer pool

  从以下版本开始:

  5.0.8

• getConnectionBuilderConsumer

  public Consumer<io.undertow.websockets.client.WebSocketClient.ConnectionBuilder> getConnectionBuilderConsumer()

  Return the configured Consumer<ConnectionBuilder>.

• execute

  public reactor.core.publisher.Mono<Void> execute​(URI url,
                                                   WebSocketHandler handler)

  从接口复制的说明: WebSocketClient
  Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

  指定者:

  execute 在接口中 WebSocketClient

  参数:

  url - the handshake url

  handler - the handler of the WebSocket session

  返回:

  completion Mono<Void> to indicate the outcome of the WebSocket session handling.

• execute

  public reactor.core.publisher.Mono<Void> execute​(URI url,
                                                   HttpHeaders headers,
                                                   WebSocketHandler handler)

  从接口复制的说明: WebSocketClient
  A variant of WebSocketClient.execute(URI, WebSocketHandler) with custom headers.

  指定者:

  execute 在接口中 WebSocketClient

  参数:

  url - the handshake url

  headers - custom headers for the handshake request

  handler - the handler of the WebSocket session

  返回:

  completion Mono<Void> to indicate the outcome of the WebSocket session handling.

• createConnectionBuilder

  protected io.undertow.websockets.client.WebSocketClient.ConnectionBuilder createConnectionBuilder​(URI url)

  Create a WebSocketClient.ConnectionBuilder for the given URI.

  The default implementation creates a builder with the configured XnioWorker and ByteBufferPool and then passes it to the consumer provided at construction time.