Interface WebSocketClient

All Known Implementing Classes:
JettyWebSocketClient, ReactorNetty2WebSocketClient, ReactorNettyWebSocketClient, StandardWebSocketClient, TomcatWebSocketClient, UndertowWebSocketClient

public interface WebSocketClient
Contract for reactive-style handling of a WebSocket session.
Since:
5.0
Author:
Rossen Stoyanchev
  • Method Details

    • execute

      reactor.core.publisher.Mono<Void> execute(URI url, WebSocketHandler handler)
      Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.
      Parameters:
      url - the handshake url
      handler - the handler of the WebSocket session
      Returns:
      completion Mono<Void> to indicate the outcome of the WebSocket session handling.
    • execute

      reactor.core.publisher.Mono<Void> execute(URI url, HttpHeaders headers, WebSocketHandler handler)
      A variant of execute(URI, WebSocketHandler) with custom headers.
      Parameters:
      url - the handshake url
      headers - custom headers for the handshake request
      handler - the handler of the WebSocket session
      Returns:
      completion Mono<Void> to indicate the outcome of the WebSocket session handling.