Package io.quarkus.websockets.next.runtime

Class BasicWebSocketConnectorImpl

java.lang.Object

io.quarkus.websockets.next.runtime.WebSocketConnectorBase<BasicWebSocketConnectorImpl>

io.quarkus.websockets.next.runtime.BasicWebSocketConnectorImpl

All Implemented Interfaces:

BasicWebSocketConnector

@Typed(BasicWebSocketConnector.class)
@Dependent
public class BasicWebSocketConnectorImpl
extends WebSocketConnectorBase<BasicWebSocketConnectorImpl>
implements BasicWebSocketConnector

Nested Class Summary

Nested classes/interfaces inherited from interface io.quarkus.websockets.next.BasicWebSocketConnector

BasicWebSocketConnector.ExecutionModel

Field Summary

Fields inherited from class io.quarkus.websockets.next.runtime.WebSocketConnectorBase

baseUri, codecs, config, connectionManager, headers, path, PATH_PARAM_PATTERN, pathParamNames, pathParams, subprotocols, tlsConfigurationRegistry, vertx

Constructor Summary

Constructors

Constructor	Description
BasicWebSocketConnectorImpl(io.vertx.core.Vertx vertx, Codecs codecs, ClientConnectionManager connectionManager, WebSocketsClientRuntimeConfig config, TlsConfigurationRegistry tlsConfigurationRegistry)

Method Summary

Modifier and Type	Method	Description
io.smallrye.mutiny.Uni<WebSocketClientConnection>	connect()
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 BasicWebSocketConnector.baseUri(URI).

Methods inherited from class io.quarkus.websockets.next.runtime.WebSocketConnectorBase

addHeader, addSubprotocol, baseUri, getPathParamNames, isSecure, newConnectOptions, pathParam, populateClientOptions, replacePathParameters, self, setPath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.quarkus.websockets.next.BasicWebSocketConnector

addHeader, addSubprotocol, baseUri, baseUri, connectAndAwait, pathParam

Constructor Details

BasicWebSocketConnectorImpl

BasicWebSocketConnectorImpl(io.vertx.core.Vertx vertx,
 Codecs codecs,
 ClientConnectionManager connectionManager,
 WebSocketsClientRuntimeConfig config,
 TlsConfigurationRegistry tlsConfigurationRegistry)

Method Details

executionModel

public BasicWebSocketConnector executionModel(BasicWebSocketConnector.ExecutionModel model)

Description copied from interface: BasicWebSocketConnector

Set the execution model for callback handlers.

By default, BasicWebSocketConnector.ExecutionModel.BLOCKING is used.

Specified by:

executionModel in interface BasicWebSocketConnector

Returns:

self

See Also:

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

path

public BasicWebSocketConnector path(String path)

Description copied from interface: BasicWebSocketConnector

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

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

Specified by:

path in interface BasicWebSocketConnector

Parameters:

path -

Returns:

self

onOpen

public BasicWebSocketConnector onOpen(Consumer<WebSocketClientConnection> consumer)

Description copied from interface: BasicWebSocketConnector

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

Specified by:

onOpen in interface BasicWebSocketConnector

Parameters:

consumer -

Returns:

self

See Also:

• BasicWebSocketConnector.executionModel(ExecutionModel)

onTextMessage

public BasicWebSocketConnector onTextMessage(BiConsumer<WebSocketClientConnection,String> consumer)

Description copied from interface: BasicWebSocketConnector

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

Specified by:

onTextMessage in interface BasicWebSocketConnector

Parameters:

consumer -

Returns:

self

See Also:

• BasicWebSocketConnector.executionModel(ExecutionModel)

onBinaryMessage

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

Description copied from interface: BasicWebSocketConnector

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

Specified by:

onBinaryMessage in interface BasicWebSocketConnector

Parameters:

consumer -

Returns:

self

See Also:

• BasicWebSocketConnector.executionModel(ExecutionModel)

onPing

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

Description copied from interface: BasicWebSocketConnector

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

Specified by:

onPing in interface BasicWebSocketConnector

Parameters:

consumer -

Returns:

self

See Also:

• BasicWebSocketConnector.executionModel(ExecutionModel)

onPong

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

Description copied from interface: BasicWebSocketConnector

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

Specified by:

onPong in interface BasicWebSocketConnector

Parameters:

consumer -

Returns:

self

See Also:

• BasicWebSocketConnector.executionModel(ExecutionModel)

onClose

public BasicWebSocketConnector onClose(BiConsumer<WebSocketClientConnection,CloseReason> consumer)

Description copied from interface: BasicWebSocketConnector

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

Specified by:

onClose in interface BasicWebSocketConnector

Parameters:

consumer -

Returns:

self

See Also:

• BasicWebSocketConnector.executionModel(ExecutionModel)

onError

public BasicWebSocketConnector onError(BiConsumer<WebSocketClientConnection,Throwable> consumer)

Description copied from interface: BasicWebSocketConnector

Set a callback to be invoked when an error occurs.

Specified by:

onError in interface BasicWebSocketConnector

Parameters:

consumer -

Returns:

self

See Also:

• BasicWebSocketConnector.executionModel(ExecutionModel)

connect

public io.smallrye.mutiny.Uni<WebSocketClientConnection> connect()

Specified by:

connect in interface BasicWebSocketConnector

Returns:

a new Uni with a WebSocketClientConnection item