Class ReactorNettyWebSocketClient

java.lang.Object

org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient

All Implemented Interfaces:

WebSocketClient

public class ReactorNettyWebSocketClient
extends Object
implements WebSocketClient

WebSocketClient implementation for use with Reactor Netty.

Since:

5.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
ReactorNettyWebSocketClient()	Default constructor.
ReactorNettyWebSocketClient(reactor.netty.http.client.HttpClient httpClient)	Constructor that accepts an existing HttpClient builder with a default WebsocketClientSpec.Builder.
ReactorNettyWebSocketClient(reactor.netty.http.client.HttpClient httpClient, Supplier<reactor.netty.http.client.WebsocketClientSpec.Builder> builderSupplier)	Constructor that accepts an existing HttpClient builder and a pre-configured WebsocketClientSpec.Builder.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<Void>	execute(URI url, HttpHeaders requestHeaders, WebSocketHandler handler)	A variant of WebSocketClient.execute(URI, WebSocketHandler) with custom headers.
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.
reactor.netty.http.client.HttpClient	getHttpClient()	Return the configured HttpClient.
reactor.netty.http.client.WebsocketClientSpec	getWebsocketClientSpec()	Build an instance of WebsocketClientSpec that reflects the current configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReactorNettyWebSocketClient

public ReactorNettyWebSocketClient()

Default constructor.

ReactorNettyWebSocketClient

public ReactorNettyWebSocketClient(reactor.netty.http.client.HttpClient httpClient)

Constructor that accepts an existing HttpClient builder with a default WebsocketClientSpec.Builder.

Since:

5.1

ReactorNettyWebSocketClient

public ReactorNettyWebSocketClient(reactor.netty.http.client.HttpClient httpClient,
 Supplier<reactor.netty.http.client.WebsocketClientSpec.Builder> builderSupplier)

Constructor that accepts an existing HttpClient builder and a pre-configured WebsocketClientSpec.Builder.

Since:

5.3

Method Details

getHttpClient

public reactor.netty.http.client.HttpClient getHttpClient()

Return the configured HttpClient.

getWebsocketClientSpec

public reactor.netty.http.client.WebsocketClientSpec getWebsocketClientSpec()

Build an instance of WebsocketClientSpec that reflects the current configuration. This can be used to check the configured parameters except for sub-protocols which depend on the WebSocketHandler that is used for a given upgrade.

Since:

5.3

execute

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

Description copied from interface: WebSocketClient

Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

Specified by:

execute in interface WebSocketClient

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

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

Description copied from interface: WebSocketClient

A variant of WebSocketClient.execute(URI, WebSocketHandler) with custom headers.

Specified by:

execute in interface WebSocketClient

Parameters:

url - the handshake url

requestHeaders - 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.