Package io.quarkus.websockets.next

Interface WebSocketConnector<CLIENT>

Type Parameters:

CLIENT - The client endpoint class

All Known Implementing Classes:

WebSocketConnectorImpl

public interface WebSocketConnector<CLIENT>

A connector can be used to configure and open a new client connection backed by a client endpoint that is used to consume and send messages.

Quarkus provides a CDI bean with bean type WebSocketConnector<CLIENT> and qualifier Default. The actual type argument of an injection point is used to determine the client endpoint. The type is validated during build and if it does not represent a client endpoint then the build fails.

This construct is not thread-safe and should not be used concurrently.

Connectors should not be reused. If you need to create multiple connections in a row you'll need to obtain a new connetor instance programmatically using Provider.get():

 import jakarta.enterprise.inject.Instance;

 @Inject
 Instance<WebSocketConnector<MyEndpoint>> connector;

 void connect() {
      var connection1 = connector.get().baseUri(uri)
                  .addHeader("Foo", "alpha")
                  .connectAndAwait();
      var connection2 = connector.get().baseUri(uri)
                  .addHeader("Foo", "bravo")
                  .connectAndAwait();
 }
 

See Also:

• WebSocketClient
• WebSocketClientConnection

Method Summary

Modifier and Type	Method	Description
WebSocketConnector<CLIENT>	addHeader(String name, String value)	Add a header used during the initial handshake request.
WebSocketConnector<CLIENT>	addSubprotocol(String value)	Add the subprotocol.
default WebSocketConnector<CLIENT>	baseUri(String baseUri)	Set the base URI.
WebSocketConnector<CLIENT>	baseUri(URI baseUri)	Set the base URI.
io.smallrye.mutiny.Uni<WebSocketClientConnection>	connect()
default WebSocketClientConnection	connectAndAwait()
WebSocketConnector<CLIENT>	customizeOptions(BiConsumer<io.vertx.core.http.WebSocketConnectOptions,io.vertx.core.http.WebSocketClientOptions> customizer)	This method allows to customize WebSocketConnectOptions and WebSocketClientOptions.
WebSocketConnector<CLIENT>	pathParam(String name, String value)	Set the path param.
WebSocketConnector<CLIENT>	tlsConfigurationName(String tlsConfigurationName)	Set the name of the TlsConfiguration.
<VALUE> WebSocketConnector<CLIENT>	userData(UserData.TypedKey<VALUE> key, VALUE value)	Add a value to the connection user data.

Method Details

baseUri

WebSocketConnector<CLIENT> baseUri(URI baseUri)

Set the base URI.

Parameters:

baseUri -

Returns:

self

baseUri

default WebSocketConnector<CLIENT> baseUri(String baseUri)

Set the base URI.

Parameters:

baseUri -

Returns:

self

tlsConfigurationName

WebSocketConnector<CLIENT> tlsConfigurationName(String tlsConfigurationName)

Set the name of the TlsConfiguration.

Parameters:

tlsConfigurationName -

Returns:

self

See Also:

• TlsConfigurationRegistry.get(String)

pathParam

WebSocketConnector<CLIENT> pathParam(String name,
 String value)

Set the path param.

The value is encoded using URLEncoder.encode(String, java.nio.charset.Charset) before it's used to build the target URI.

Parameters:

name -

value -

Returns:

self

Throws:

IllegalArgumentException - If the client endpoint path does not contain a parameter with the given name

See Also:

• WebSocketClient.path()

addHeader

WebSocketConnector<CLIENT> addHeader(String name,
 String value)

Add a header used during the initial handshake request.

Parameters:

name -

value -

Returns:

self

See Also:

• HandshakeRequest

addSubprotocol

WebSocketConnector<CLIENT> addSubprotocol(String value)

Add the subprotocol.

Parameters:

value -

name -

Returns:

self

userData

<VALUE> WebSocketConnector<CLIENT> userData(UserData.TypedKey<VALUE> key,
 VALUE value)

Add a value to the connection user data.

Type Parameters:

VALUE -

Parameters:

key -

value -

Returns:

self

See Also:

• UserData.put(TypedKey, Object)
• Connection.userData()

connect

@CheckReturnValue
io.smallrye.mutiny.Uni<WebSocketClientConnection> connect()

Returns:

a new Uni with a WebSocketClientConnection item

connectAndAwait

default WebSocketClientConnection connectAndAwait()

Returns:

the client connection

customizeOptions

WebSocketConnector<CLIENT> customizeOptions(BiConsumer<io.vertx.core.http.WebSocketConnectOptions,io.vertx.core.http.WebSocketClientOptions> customizer)

This method allows to customize WebSocketConnectOptions and WebSocketClientOptions. Connection options configured directly with this API, such as host and port, have higher priority than this customizer. Client options configured directly with Quarkus configuration (e.g. if you configure the maximum size of a frame) have also higher priority than this customizer. Purpose of this customizer is to complement configuration options not configured elsewhere.

Parameters:

customizer - options customizer; must not be null

Returns:

self