Modifier and Type	Class and Description
private static class	UndertowWebSocketClient.DefaultNegotiation

Modifier and Type	Field and Description
private final Consumer<WebSocketClient.ConnectionBuilder>	builderConsumer
private ByteBufferPool	byteBufferPool
private static final int	DEFAULT_POOL_BUFFER_SIZE
private static final Log	logger
private final XnioWorker	worker

Constructor Summary

Access	Constructor and Description
public	UndertowWebSocketClient(XnioWorker the Xnio worker worker) Constructor with the `XnioWorker` to pass to `io.undertow.websockets.client.WebSocketClient#connectionBuilder`.
public	UndertowWebSocketClient(XnioWorker the Xnio worker to use to create `ConnectionBuilder`'s worker, Consumer<WebSocketClient.ConnectionBuilder> a consumer to configure `ConnectionBuilder`'s builderConsumer) Alternate constructor providing additional control over the `ConnectionBuilder` for each WebSocket connection.
public	UndertowWebSocketClient(XnioWorker the Xnio worker to use to create `ConnectionBuilder`'s worker, ByteBufferPool the ByteBufferPool to use to create `ConnectionBuilder`'s byteBufferPool, Consumer<WebSocketClient.ConnectionBuilder> a consumer to configure `ConnectionBuilder`'s builderConsumer) Alternate constructor providing additional control over the `ConnectionBuilder` for each WebSocket connection.

Method Summary

Modifier and Type	Method and Description
protected WebSocketClient.ConnectionBuilder	createConnectionBuilder(URI url) Create a `ConnectionBuilder` for the given URI.
private HandshakeInfo	createHandshakeInfo(URI url, UndertowWebSocketClient.DefaultNegotiation negotiation)
public Mono<Void>	execute(URI the handshake url url, WebSocketHandler the handler of the WebSocket session handler) Implements org.springframework.web.reactive.socket.client.WebSocketClient.execute. Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.
public Mono<Void>	execute(URI the handshake url url, HttpHeaders custom headers for the handshake request headers, WebSocketHandler the handler of the WebSocket session handler) Implements org.springframework.web.reactive.socket.client.WebSocketClient.execute. A variant of `execute(URI, WebSocketHandler)` with custom headers.
private Mono<Void>	executeInternal(URI url, HttpHeaders headers, WebSocketHandler handler)
public ByteBufferPool	Returns: the byte buffer pool getByteBufferPool() Return the `io.undertow.connector.ByteBufferPool` currently used for newly created WebSocket sessions by this client.
public Consumer<WebSocketClient.ConnectionBuilder>	getConnectionBuilderConsumer() Return the configured `Consumer<ConnectionBuilder>`.
public XnioWorker	getXnioWorker() Return the configured `XnioWorker`.
private void	handleChannel(URI url, WebSocketHandler handler, Sinks.Empty<Void> completionSink, UndertowWebSocketClient.DefaultNegotiation negotiation, WebSocketChannel channel)
public void	setByteBufferPool(ByteBufferPool byteBufferPool) Set the `ByteBufferPool` to pass to `io.undertow.websockets.client.WebSocketClient#connectionBuilder`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

builderConsumer	back to summary
private final Consumer<WebSocketClient.ConnectionBuilder> builderConsumer

byteBufferPool	back to summary
private ByteBufferPool byteBufferPool

DEFAULT_POOL_BUFFER_SIZE	back to summary
private static final int DEFAULT_POOL_BUFFER_SIZE

logger	back to summary
private static final Log logger

worker	back to summary
private final XnioWorker worker

Constructor Detail

UndertowWebSocketClient back to summary

UndertowWebSocketClient	back to summary
public UndertowWebSocketClient(XnioWorker worker) Constructor with the `XnioWorker` to pass to `io.undertow.websockets.client.WebSocketClient#connectionBuilder`. Parameters worker:XnioWorker the Xnio worker

public UndertowWebSocketClient(XnioWorker worker)

Constructor with the XnioWorker to pass to io.undertow.websockets.client.WebSocketClient#connectionBuilder.

Parameters

worker:XnioWorker: the Xnio worker

UndertowWebSocketClient back to summary

UndertowWebSocketClient	back to summary
public UndertowWebSocketClient(XnioWorker worker, Consumer<WebSocketClient.ConnectionBuilder> builderConsumer) Alternate constructor providing additional control over the `ConnectionBuilder` for each WebSocket connection. Parameters worker:XnioWorker the Xnio worker to use to create `ConnectionBuilder`'s builderConsumer:Consumer<WebSocketClient.ConnectionBuilder> a consumer to configure `ConnectionBuilder`'s

public UndertowWebSocketClient(XnioWorker worker, Consumer<WebSocketClient.ConnectionBuilder> builderConsumer)

Alternate constructor providing additional control over the ConnectionBuilder for each WebSocket connection.

Parameters

worker:XnioWorker: the Xnio worker to use to create ConnectionBuilder's
builderConsumer:Consumer<WebSocketClient.ConnectionBuilder>: a consumer to configure ConnectionBuilder's

UndertowWebSocketClient back to summary

UndertowWebSocketClient	back to summary
public UndertowWebSocketClient(XnioWorker worker, ByteBufferPool byteBufferPool, Consumer<WebSocketClient.ConnectionBuilder> builderConsumer) Alternate constructor providing additional control over the `ConnectionBuilder` for each WebSocket connection. Parameters worker:XnioWorker the Xnio worker to use to create `ConnectionBuilder`'s byteBufferPool:ByteBufferPool the ByteBufferPool to use to create `ConnectionBuilder`'s builderConsumer:Consumer<WebSocketClient.ConnectionBuilder> a consumer to configure `ConnectionBuilder`'s Since 5.0.8

public UndertowWebSocketClient(XnioWorker worker, ByteBufferPool byteBufferPool, Consumer<WebSocketClient.ConnectionBuilder> builderConsumer)

Alternate constructor providing additional control over the ConnectionBuilder for each WebSocket connection.

Parameters

worker:XnioWorker: the Xnio worker to use to create ConnectionBuilder's
byteBufferPool:ByteBufferPool: the ByteBufferPool to use to create ConnectionBuilder's
builderConsumer:Consumer<WebSocketClient.ConnectionBuilder>: a consumer to configure ConnectionBuilder's

Since

5.0.8

Method Detail

createConnectionBuilder back to summary

createConnectionBuilder	back to summary
protected WebSocketClient.ConnectionBuilder createConnectionBuilder(URI url) Create a `ConnectionBuilder` for the given URI. The default implementation creates a builder with the configured `XnioWorker` and `ByteBufferPool` and then passes it to the `consumer` provided at construction time.

protected WebSocketClient.ConnectionBuilder createConnectionBuilder(URI url)

Create a ConnectionBuilder for the given URI.

The default implementation creates a builder with the configured XnioWorker and ByteBufferPool and then passes it to the consumer provided at construction time.

createHandshakeInfo	back to summary
private HandshakeInfo createHandshakeInfo(URI url, UndertowWebSocketClient.DefaultNegotiation negotiation)

execute back to summary

execute	back to summary
public Mono<Void> execute(URI url, WebSocketHandler handler) Implements org.springframework.web.reactive.socket.client.WebSocketClient.execute. Doc from org.springframework.web.reactive.socket.client.WebSocketClient.execute. Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler. Parameters url:URI the handshake url handler:WebSocketHandler the handler of the WebSocket session Returns:Mono<Void> completion `Mono<Void>` to indicate the outcome of the WebSocket session handling. Annotations @Override

public Mono<Void> execute(URI url, WebSocketHandler handler)

Implements org.springframework.web.reactive.socket.client.WebSocketClient.execute.

Doc from org.springframework.web.reactive.socket.client.WebSocketClient.execute.

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

Parameters

url:URI: the handshake url
handler:WebSocketHandler: the handler of the WebSocket session

Returns:Mono<Void>

completion Mono<Void> to indicate the outcome of the WebSocket session handling.

Annotations

@Override

execute back to summary

execute	back to summary
public Mono<Void> execute(URI url, HttpHeaders headers, WebSocketHandler handler) Implements org.springframework.web.reactive.socket.client.WebSocketClient.execute. Doc from org.springframework.web.reactive.socket.client.WebSocketClient.execute. A variant of `execute(URI, WebSocketHandler)` with custom headers. Parameters url:URI the handshake url headers:HttpHeaders custom headers for the handshake request handler:WebSocketHandler the handler of the WebSocket session Returns:Mono<Void> completion `Mono<Void>` to indicate the outcome of the WebSocket session handling. Annotations @Override

public Mono<Void> execute(URI url, HttpHeaders headers, WebSocketHandler handler)

Implements org.springframework.web.reactive.socket.client.WebSocketClient.execute.

Doc from org.springframework.web.reactive.socket.client.WebSocketClient.execute.

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

Parameters

url:URI: the handshake url
headers:HttpHeaders: custom headers for the handshake request
handler:WebSocketHandler: the handler of the WebSocket session

Returns:Mono<Void>

completion Mono<Void> to indicate the outcome of the WebSocket session handling.

Annotations

@Override

executeInternal	back to summary
private Mono<Void> executeInternal(URI url, HttpHeaders headers, WebSocketHandler handler)

getByteBufferPool back to summary

getByteBufferPool	back to summary
public ByteBufferPool getByteBufferPool() Return the `io.undertow.connector.ByteBufferPool` currently used for newly created WebSocket sessions by this client. Returns:ByteBufferPool the byte buffer pool Since 5.0.8

public ByteBufferPool getByteBufferPool()

Return the io.undertow.connector.ByteBufferPool currently used for newly created WebSocket sessions by this client.

Returns:ByteBufferPool: the byte buffer pool
Since: 5.0.8

getConnectionBuilderConsumer	back to summary
public Consumer<WebSocketClient.ConnectionBuilder> getConnectionBuilderConsumer() Return the configured `Consumer<ConnectionBuilder>`.

getXnioWorker	back to summary
public XnioWorker getXnioWorker() Return the configured `XnioWorker`.

handleChannel	back to summary
private void handleChannel(URI url, WebSocketHandler handler, Sinks.Empty<Void> completionSink, UndertowWebSocketClient.DefaultNegotiation negotiation, WebSocketChannel channel)

setByteBufferPool back to summary

setByteBufferPool	back to summary
public void setByteBufferPool(ByteBufferPool byteBufferPool) Set the `ByteBufferPool` to pass to `io.undertow.websockets.client.WebSocketClient#connectionBuilder`. By default an indirect `io.undertow.server.DefaultByteBufferPool` with a buffer size of 8192 is used. Since 5.0.8 See Also `DEFAULT_POOL_BUFFER_SIZE`

public void setByteBufferPool(ByteBufferPool byteBufferPool)

Set the ByteBufferPool to pass to io.undertow.websockets.client.WebSocketClient#connectionBuilder.

By default an indirect io.undertow.server.DefaultByteBufferPool with a buffer size of 8192 is used.

Since: 5.0.8
See Also: DEFAULT_POOL_BUFFER_SIZE

org.springframework.web.reactive.socket.client back to summary

private final Class UndertowWebSocketClient.DefaultNegotiation

Class Inheritance

extends WebSocketClientNegotiation

java.lang.Object
io.undertow.websockets.client.WebSocketClientNegotiation
org.springframework.web.reactive.socket.client.UndertowWebSocketClient.DefaultNegotiation

Field Summary

Modifier and Type	Field and Description
private final WebSocketClientNegotiation	delegate
private final HttpHeaders	requestHeaders
private final HttpHeaders	responseHeaders

Constructor Summary

Access	Constructor and Description
public	DefaultNegotiation(List<String> protocols, HttpHeaders requestHeaders, WebSocketClient.ConnectionBuilder connectionBuilder)

Method Summary

Modifier and Type	Method and Description
public void	afterRequest(Map<String, List<String>> headers) Overrides io.undertow.websockets.client.WebSocketClientNegotiation.afterRequest.
public void	beforeRequest(Map<String, List<String>> headers) Overrides io.undertow.websockets.client.WebSocketClientNegotiation.beforeRequest.
public HttpHeaders	getResponseHeaders()

Inherited from io.undertow.websockets.client.WebSocketClientNegotiation:: getSelectedExtensions getSelectedSubProtocol getSupportedExtensions getSupportedSubProtocols handshakeComplete

Field Detail

delegate	back to summary
private final WebSocketClientNegotiation delegate Annotations @Nullable

requestHeaders	back to summary
private final HttpHeaders requestHeaders

responseHeaders	back to summary
private final HttpHeaders responseHeaders

Constructor Detail

DefaultNegotiation	back to summary
public DefaultNegotiation(List<String> protocols, HttpHeaders requestHeaders, WebSocketClient.ConnectionBuilder connectionBuilder)

Method Detail

afterRequest	back to summary
public void afterRequest(Map<String, List<String>> headers) Overrides io.undertow.websockets.client.WebSocketClientNegotiation.afterRequest. Annotations @Override

afterRequest

back to summary

public void afterRequest(Map<String, List<String>> headers)

Overrides io.undertow.websockets.client.WebSocketClientNegotiation.afterRequest.

Annotations

@Override

beforeRequest	back to summary
public void beforeRequest(Map<String, List<String>> headers) Overrides io.undertow.websockets.client.WebSocketClientNegotiation.beforeRequest. Annotations @Override

beforeRequest

back to summary

public void beforeRequest(Map<String, List<String>> headers)

Overrides io.undertow.websockets.client.WebSocketClientNegotiation.beforeRequest.

Annotations

@Override

getResponseHeaders	back to summary
public HttpHeaders getResponseHeaders()

public Class UndertowWebSocketClient

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class UndertowWebSocketClient.DefaultNegotiation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail