public class JettyWebSocketClient extends Object implements WebSocketClient, org.springframework.context.Lifecycle
WebSocketClient
implementation for use with Jetty
WebSocketClient
.
Note: the Jetty WebSocketClient
requires
lifecycle management and must be started and stopped. This is automatically
managed when this class is declared as a Spring bean and created with the
default constructor. See constructor notes for more details.
Constructor and Description |
---|
JettyWebSocketClient()
Default constructor that creates and manages an instance of a Jetty
WebSocketClient . |
JettyWebSocketClient(org.eclipse.jetty.websocket.client.WebSocketClient jettyClient)
Constructor that accepts an existing instance of a Jetty
WebSocketClient . |
Modifier and Type | Method and Description |
---|---|
reactor.core.publisher.Mono<Void> |
execute(URI url,
org.springframework.http.HttpHeaders headers,
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.
|
org.eclipse.jetty.websocket.client.WebSocketClient |
getJettyClient()
Return the underlying Jetty
WebSocketClient . |
boolean |
isRunning() |
void |
start() |
void |
stop() |
public JettyWebSocketClient()
WebSocketClient
.
The instance can be obtained with getJettyClient()
for further
configuration.
Note: When this constructor is used Lifecycle
methods of this class are delegated to the Jetty WebSocketClient
.
public JettyWebSocketClient(org.eclipse.jetty.websocket.client.WebSocketClient jettyClient)
WebSocketClient
.
Note: Use of this constructor implies the Jetty
WebSocketClient
is externally managed and hence Lifecycle
methods of this class are not delegated to it.
public org.eclipse.jetty.websocket.client.WebSocketClient getJettyClient()
WebSocketClient
.public void start()
start
in interface org.springframework.context.Lifecycle
public void stop()
stop
in interface org.springframework.context.Lifecycle
public boolean isRunning()
isRunning
in interface org.springframework.context.Lifecycle
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, org.springframework.http.HttpHeaders headers, WebSocketHandler handler)
WebSocketClient
WebSocketClient.execute(URI, WebSocketHandler)
with custom headers.execute
in interface WebSocketClient
url
- the handshake urlheaders
- custom headers for the handshake requesthandler
- the handler of the WebSocket sessionMono<Void>
to indicate the outcome of the
WebSocket session handling.