Class ReactorNetty2WebSocketClient
java.lang.Object
org.springframework.web.reactive.socket.client.ReactorNetty2WebSocketClient
- All Implemented Interfaces:
WebSocketClient
WebSocketClient
implementation for use with Reactor Netty for Netty 5.
This class is based on ReactorNettyWebSocketClient
.
- Since:
- 6.0
- Author:
- Violeta Georgieva
-
Constructor Summary
ConstructorDescriptionDefault constructor.ReactorNetty2WebSocketClient
(reactor.netty5.http.client.HttpClient httpClient) Constructor that accepts an existingHttpClient
builder with a defaultWebsocketClientSpec.Builder
.ReactorNetty2WebSocketClient
(reactor.netty5.http.client.HttpClient httpClient, Supplier<reactor.netty5.http.client.WebsocketClientSpec.Builder> builderSupplier) Constructor that accepts an existingHttpClient
builder and a pre-configuredWebsocketClientSpec.Builder
. -
Method Summary
Modifier and TypeMethodDescriptionreactor.core.publisher.Mono<Void>
execute
(URI url, HttpHeaders requestHeaders, WebSocketHandler handler) A variant ofWebSocketClient.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.netty5.http.client.HttpClient
Return the configuredHttpClient
.reactor.netty5.http.client.WebsocketClientSpec
Build an instance ofWebsocketClientSpec
that reflects the current configuration.
-
Constructor Details
-
ReactorNetty2WebSocketClient
public ReactorNetty2WebSocketClient()Default constructor. -
ReactorNetty2WebSocketClient
public ReactorNetty2WebSocketClient(reactor.netty5.http.client.HttpClient httpClient) Constructor that accepts an existingHttpClient
builder with a defaultWebsocketClientSpec.Builder
.- Since:
- 5.1
-
ReactorNetty2WebSocketClient
public ReactorNetty2WebSocketClient(reactor.netty5.http.client.HttpClient httpClient, Supplier<reactor.netty5.http.client.WebsocketClientSpec.Builder> builderSupplier) Constructor that accepts an existingHttpClient
builder and a pre-configuredWebsocketClientSpec.Builder
.
-
-
Method Details
-
getHttpClient
public reactor.netty5.http.client.HttpClient getHttpClient()Return the configuredHttpClient
. -
getWebsocketClientSpec
public reactor.netty5.http.client.WebsocketClientSpec getWebsocketClientSpec()Build an instance ofWebsocketClientSpec
that reflects the current configuration. This can be used to check the configured parameters except for sub-protocols which depend on theWebSocketHandler
that is used for a given upgrade. -
execute
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 interfaceWebSocketClient
- Parameters:
url
- the handshake urlhandler
- 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 ofWebSocketClient.execute(URI, WebSocketHandler)
with custom headers.- Specified by:
execute
in interfaceWebSocketClient
- Parameters:
url
- the handshake urlrequestHeaders
- custom headers for the handshake requesthandler
- the handler of the WebSocket session- Returns:
- completion
Mono<Void>
to indicate the outcome of the WebSocket session handling.
-