Package io.quarkus.websockets.next

Interface BasicWebSocketConnector

All Known Implementing Classes:

BasicWebSocketConnectorImpl

public interface BasicWebSocketConnector

A basic connector can be used to configure and open a new client connection. Unlike with WebSocketConnector a client endpoint is not used to consume and send messages.

Quarkus provides a CDI bean with bean type BasicWebSocketConnector and qualifier Default.

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<BasicWebSocketConnector> 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:

• WebSocketClientConnection

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BasicWebSocketConnector.ExecutionModel

Method Summary

Modifier and Type	Method	Description
BasicWebSocketConnector	addHeader(String name, String value)	Add a header used during the initial handshake request.
BasicWebSocketConnector	addSubprotocol(String value)	Add the subprotocol.
default BasicWebSocketConnector	baseUri(String baseUri)	Set the base URI.
BasicWebSocketConnector	baseUri(URI uri)	Set the base URI.
io.smallrye.mutiny.Uni<WebSocketClientConnection>	connect()
default WebSocketClientConnection	connectAndAwait()
static BasicWebSocketConnector	create()	Obtains a new basic connector.
BasicWebSocketConnector	customizeOptions(BiConsumer<io.vertx.core.http.WebSocketConnectOptions,io.vertx.core.http.WebSocketClientOptions> customizer)	This method allows to customize WebSocketConnectOptions and WebSocketClientOptions.
BasicWebSocketConnector	executionModel(BasicWebSocketConnector.ExecutionModel model)	Set the execution model for callback handlers.
BasicWebSocketConnector	onBinaryMessage(BiConsumer<WebSocketClientConnection,io.vertx.core.buffer.Buffer> consumer)	Set a callback to be invoked when a binary message is received from the server.
BasicWebSocketConnector	onClose(BiConsumer<WebSocketClientConnection,CloseReason> consumer)	Set a callback to be invoked when a connection to the server is closed.
BasicWebSocketConnector	onError(BiConsumer<WebSocketClientConnection,Throwable> consumer)	Set a callback to be invoked when an error occurs.
BasicWebSocketConnector	onOpen(Consumer<WebSocketClientConnection> consumer)	Set a callback to be invoked when a connection to the server is open.
BasicWebSocketConnector	onPing(BiConsumer<WebSocketClientConnection,io.vertx.core.buffer.Buffer> consumer)	Set a callback to be invoked when a ping message is received from the server.
BasicWebSocketConnector	onPong(BiConsumer<WebSocketClientConnection,io.vertx.core.buffer.Buffer> consumer)	Set a callback to be invoked when a pong message is received from the server.
BasicWebSocketConnector	onTextMessage(BiConsumer<WebSocketClientConnection,String> consumer)	Set a callback to be invoked when a text message is received from the server.
BasicWebSocketConnector	path(String path)	Set the path that should be appended to the path of the URI set by baseUri(URI).
BasicWebSocketConnector	pathParam(String name, String value)	Set the path param.
BasicWebSocketConnector	tlsConfigurationName(String tlsConfigurationName)	Set the name of the TlsConfiguration.
<VALUE> BasicWebSocketConnector	userData(UserData.TypedKey<VALUE> key, VALUE value)	Add a value to the connection user data.

Method Details

create

static BasicWebSocketConnector create()

Obtains a new basic connector. An alternative to @Inject BasicWebSocketConnector.

Returns:

a new basic connector

baseUri

BasicWebSocketConnector baseUri(URI uri)

Set the base URI.

Parameters:

uri -

Returns:

self

baseUri

default BasicWebSocketConnector baseUri(String baseUri)

Set the base URI.

Parameters:

baseUri -

Returns:

self

tlsConfigurationName

BasicWebSocketConnector tlsConfigurationName(String tlsConfigurationName)

Set the name of the TlsConfiguration.

Parameters:

tlsConfigurationName -

Returns:

self

See Also:

• TlsConfigurationRegistry.get(String)

path

BasicWebSocketConnector path(String path)

Set the path that should be appended to the path of the URI set by baseUri(URI).

The path may contain path parameters as defined by WebSocketClient.path(). In this case, the pathParam(String, String) method must be used to pass path param values.

Parameters:

path -

Returns:

self

pathParam

BasicWebSocketConnector 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 path set by path(String) does not contain a parameter with the given name

addHeader

BasicWebSocketConnector addHeader(String name,
 String value)

Add a header used during the initial handshake request.

Parameters:

name -

value -

Returns:

self

See Also:

• HandshakeRequest

addSubprotocol

BasicWebSocketConnector addSubprotocol(String value)

Add the subprotocol.

Parameters:

value -

name -

Returns:

self

userData

<VALUE> BasicWebSocketConnector 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()

executionModel

BasicWebSocketConnector executionModel(BasicWebSocketConnector.ExecutionModel model)

Set the execution model for callback handlers.

By default, BasicWebSocketConnector.ExecutionModel.BLOCKING is used.

Returns:

self

See Also:

• onTextMessage(BiConsumer)
• onBinaryMessage(BiConsumer)
• onPong(BiConsumer)
• onOpen(Consumer)
• onClose(BiConsumer)
• onError(BiConsumer)

onOpen

BasicWebSocketConnector onOpen(Consumer<WebSocketClientConnection> consumer)

Set a callback to be invoked when a connection to the server is open.

Parameters:

consumer -

Returns:

self

See Also:

• executionModel(ExecutionModel)

onTextMessage

BasicWebSocketConnector onTextMessage(BiConsumer<WebSocketClientConnection,String> consumer)

Set a callback to be invoked when a text message is received from the server.

Parameters:

consumer -

Returns:

self

See Also:

• executionModel(ExecutionModel)

onBinaryMessage

BasicWebSocketConnector onBinaryMessage(BiConsumer<WebSocketClientConnection,io.vertx.core.buffer.Buffer> consumer)

Set a callback to be invoked when a binary message is received from the server.

Parameters:

consumer -

Returns:

self

See Also:

• executionModel(ExecutionModel)

onPing

BasicWebSocketConnector onPing(BiConsumer<WebSocketClientConnection,io.vertx.core.buffer.Buffer> consumer)

Set a callback to be invoked when a ping message is received from the server.

Parameters:

consumer -

Returns:

self

See Also:

• executionModel(ExecutionModel)

onPong

BasicWebSocketConnector onPong(BiConsumer<WebSocketClientConnection,io.vertx.core.buffer.Buffer> consumer)

Set a callback to be invoked when a pong message is received from the server.

Parameters:

consumer -

Returns:

self

See Also:

• executionModel(ExecutionModel)

onClose

BasicWebSocketConnector onClose(BiConsumer<WebSocketClientConnection,CloseReason> consumer)

Set a callback to be invoked when a connection to the server is closed.

Parameters:

consumer -

Returns:

self

See Also:

• executionModel(ExecutionModel)

onError

BasicWebSocketConnector onError(BiConsumer<WebSocketClientConnection,Throwable> consumer)

Set a callback to be invoked when an error occurs.

Parameters:

consumer -

Returns:

self

See Also:

• executionModel(ExecutionModel)

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

BasicWebSocketConnector 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