Package io.quarkus.websockets.next.runtime

Interface WebSocketEndpoint

All Known Implementing Classes:

ForwardingWebSocketEndpoint, MetricsForwardingWebSocketEndpoint, TracesForwardingWebSocketEndpoint, WebSocketEndpointBase

public interface WebSocketEndpoint

Internal representation of a WebSocket endpoint.

A new instance is created for each connection.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	WebSocketEndpoint.ExecutionModel

Method Summary

Modifier and Type	Method	Description
String	beanIdentifier()
default Type	consumedBinaryMultiType()
default Type	consumedTextMultiType()
default Object	decodeBinaryMultiItem(Object message)
default Object	decodeTextMultiItem(Object message)
io.smallrye.mutiny.Uni<Void>	doOnError(Throwable t)
InboundProcessingMode	inboundProcessingMode()
io.vertx.core.Future<Void>	onBinaryMessage(Object message)
default WebSocketEndpoint.ExecutionModel	onBinaryMessageExecutionModel()
io.vertx.core.Future<Void>	onClose()
default WebSocketEndpoint.ExecutionModel	onCloseExecutionModel()
io.vertx.core.Future<Void>	onOpen()
default WebSocketEndpoint.ExecutionModel	onOpenExecutionModel()
io.vertx.core.Future<Void>	onPingMessage(io.vertx.core.buffer.Buffer message)
default WebSocketEndpoint.ExecutionModel	onPingMessageExecutionModel()
io.vertx.core.Future<Void>	onPongMessage(io.vertx.core.buffer.Buffer message)
default WebSocketEndpoint.ExecutionModel	onPongMessageExecutionModel()
io.vertx.core.Future<Void>	onTextMessage(Object message)
default WebSocketEndpoint.ExecutionModel	onTextMessageExecutionModel()

Method Details

inboundProcessingMode

InboundProcessingMode inboundProcessingMode()

Returns:

the inbound processing mode

onOpen

io.vertx.core.Future<Void> onOpen()

onOpenExecutionModel

default WebSocketEndpoint.ExecutionModel onOpenExecutionModel()

onTextMessage

io.vertx.core.Future<Void> onTextMessage(Object message)

onTextMessageExecutionModel

default WebSocketEndpoint.ExecutionModel onTextMessageExecutionModel()

consumedTextMultiType

default Type consumedTextMultiType()

decodeTextMultiItem

default Object decodeTextMultiItem(Object message)

onBinaryMessage

io.vertx.core.Future<Void> onBinaryMessage(Object message)

onBinaryMessageExecutionModel

default WebSocketEndpoint.ExecutionModel onBinaryMessageExecutionModel()

consumedBinaryMultiType

default Type consumedBinaryMultiType()

decodeBinaryMultiItem

default Object decodeBinaryMultiItem(Object message)

onPingMessage

io.vertx.core.Future<Void> onPingMessage(io.vertx.core.buffer.Buffer message)

onPingMessageExecutionModel

default WebSocketEndpoint.ExecutionModel onPingMessageExecutionModel()

onPongMessage

io.vertx.core.Future<Void> onPongMessage(io.vertx.core.buffer.Buffer message)

onPongMessageExecutionModel

default WebSocketEndpoint.ExecutionModel onPongMessageExecutionModel()

onClose

io.vertx.core.Future<Void> onClose()

onCloseExecutionModel

default WebSocketEndpoint.ExecutionModel onCloseExecutionModel()

doOnError

io.smallrye.mutiny.Uni<Void> doOnError(Throwable t)

beanIdentifier

String beanIdentifier()

Returns:

the identifier of the bean with callbacks

See Also:

• InjectableBean.getIdentifier()