public class ReactorNettyWebSocketClient extends Object implements WebSocketClient
WebSocketClient
implementation for use with Reactor Netty.Constructor and Description |
---|
ReactorNettyWebSocketClient()
Default constructor.
|
ReactorNettyWebSocketClient(reactor.netty.http.client.HttpClient httpClient)
Constructor that accepts an existing
HttpClient builder. |
Modifier and Type | Method and 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.
|
boolean |
getHandlePing()
Return the configured
setHandlePing(boolean) . |
reactor.netty.http.client.HttpClient |
getHttpClient()
Return the configured
HttpClient . |
int |
getMaxFramePayloadLength()
Return the configured
maxFramePayloadLength . |
void |
setHandlePing(boolean handlePing)
Configure whether to let ping frames through to be handled by the
WebSocketHandler given to the execute method. |
void |
setMaxFramePayloadLength(int maxFramePayloadLength)
Configure the maximum allowable frame payload length.
|
public ReactorNettyWebSocketClient()
public ReactorNettyWebSocketClient(reactor.netty.http.client.HttpClient httpClient)
HttpClient
builder.public reactor.netty.http.client.HttpClient getHttpClient()
HttpClient
.public void setMaxFramePayloadLength(int maxFramePayloadLength)
Corresponds to the argument with the same name in the constructor of
WebSocketServerHandshakerFactory
in Netty.
By default set to 65536 (64K).
maxFramePayloadLength
- the max length for frames.public int getMaxFramePayloadLength()
maxFramePayloadLength
.public void setHandlePing(boolean handlePing)
WebSocketHandler
given to the execute method. By default, Reactor
Netty automatically replies with pong frames in response to pings. This is
useful in a proxy for allowing ping and pong frames through.
By default this is set to false
in which case ping frames are
handled automatically by Reactor Netty. If set to true
, ping
frames will be passed through to the WebSocketHandler
.
handlePing
- whether to let Ping frames through for handlingpublic boolean getHandlePing()
setHandlePing(boolean)
.public reactor.core.publisher.Mono<Void> execute(URI url, WebSocketHandler handler)
WebSocketClient
execute
in interface WebSocketClient
url
- the handshake urlhandler
- the handler of the WebSocket sessionMono<Void>
to indicate the outcome of the
WebSocket session handling.public reactor.core.publisher.Mono<Void> execute(URI url, HttpHeaders requestHeaders, WebSocketHandler handler)
WebSocketClient
WebSocketClient.execute(URI, WebSocketHandler)
with custom headers.execute
in interface WebSocketClient
url
- the handshake urlrequestHeaders
- custom headers for the handshake requesthandler
- the handler of the WebSocket sessionMono<Void>
to indicate the outcome of the
WebSocket session handling.