io.smallrye.graphql.client.vertx.websocket

Interface WebSocketSubprotocolHandler

All Known Implementing Classes:

GraphQLTransportWSSubprotocolHandler, GraphQLWSSubprotocolHandler

public interface WebSocketSubprotocolHandler

An implementation of this interface is responsible for handling a particular subscription websocket protocol. It is responsible for registering a handler to listen for messages on the websocket, and then use the provided `MultiEmitter` to emit individual responses with raw GraphQL data. The implementation is responsible for closing the websocket if it encounters an error or the subscription ends, but it must also always be ready for the case that the websocket gets closed from somewhere else. If the websocket is closed, the data emitter must be closed, and vice versa.

Method Summary

Modifier and Type	Method and Description
void	handleCancel() Called when the subscription is cancelled on the client side (by the user).
void	handleWebSocketStart(javax.json.JsonObject request, io.smallrye.mutiny.subscription.MultiEmitter<? super String> dataEmitter, io.vertx.core.http.WebSocket webSocket) Called after the websocket channel is successfully initialized.

Method Detail

handleWebSocketStart

void handleWebSocketStart(javax.json.JsonObject request,
                          io.smallrye.mutiny.subscription.MultiEmitter<? super String> dataEmitter,
                          io.vertx.core.http.WebSocket webSocket)

Called after the websocket channel is successfully initialized. This should register a handler that handles the communication over the websocket and also relay received data through the `dataEmitter`.

handleCancel

void handleCancel()

Called when the subscription is cancelled on the client side (by the user).