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>	pathParam(String name, String value)	Set the path param.

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

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

connect

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

Returns:

a new Uni with a WebSocketClientConnection item

connectAndAwait

default WebSocketClientConnection connectAndAwait()

Returns:

the client connection