Package io.quarkus.websockets.next

Interface WebSocketClientConnection

All Superinterfaces:

BlockingSender, Sender

All Known Implementing Classes:

WebSocketClientConnectionImpl

@Experimental("This API is experimental and may change in the future")
public interface WebSocketClientConnection
extends Sender, BlockingSender

This interface represents a client connection to a WebSocket endpoint.

Quarkus provides a built-in CDI bean that implements this interface and can be injected in a WebSocketClient endpoint and used to interact with the connected server.

Method Summary

Modifier and Type	Method	Description
String	clientId()
default io.smallrye.mutiny.Uni<Void>	close()	Close the connection.
io.smallrye.mutiny.Uni<Void>	close(CloseReason reason)	Close the connection with a specific reason.
default void	closeAndAwait()	Close the connection and wait for the completion.
default void	closeAndAwait(CloseReason reason)	Close the connection with a specific reason and wait for the completion.
CloseReason	closeReason()
HandshakeRequest	handshakeRequest()
String	id()
boolean	isClosed()
default boolean	isOpen()
boolean	isSecure()
String	pathParam(String name)

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

sendBinaryAndAwait, sendBinaryAndAwait, sendPingAndAwait, sendPongAndAwait, sendTextAndAwait, sendTextAndAwait

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

sendBinary, sendBinary, sendPing, sendPong, sendText, sendText

Method Details

id

String id()

Returns:

the unique identifier assigned to this connection

clientId

String clientId()

pathParam

String pathParam(String name)

Parameters:

name -

Returns:

the value of the path parameter or null

See Also:

• WebSocketClient.path()

isSecure

boolean isSecure()

Returns:

true if the HTTP connection is encrypted via SSL/TLS

isClosed

boolean isClosed()

Returns:

true if the WebSocket is closed

closeReason

CloseReason closeReason()

Returns:

the close reason or null if the connection is not closed

isOpen

default boolean isOpen()

Returns:

true if the WebSocket is open

close

@CheckReturnValue
default io.smallrye.mutiny.Uni<Void> close()

Close the connection.

Returns:

a new Uni with a null item

close

io.smallrye.mutiny.Uni<Void> close(CloseReason reason)

Close the connection with a specific reason.

Parameters:

reason -

Returns:

a new Uni with a null item

closeAndAwait

default void closeAndAwait()

Close the connection and wait for the completion.

closeAndAwait

default void closeAndAwait(CloseReason reason)

Close the connection with a specific reason and wait for the completion.

handshakeRequest

HandshakeRequest handshakeRequest()

Returns:

the handshake request