com.graphql_java_generator.client.SubscriptionClient Maven / Gradle / Ivy
/**
*
*/
package com.graphql_java_generator.client;
import org.springframework.web.reactive.socket.WebSocketSession;
import com.graphql_java_generator.exception.GraphQLRequestExecutionException;
/**
* This interface allows the application to interact with the subscription, once it has subscribed to it. The currently
* only available action is {@link #unsubscribe()}.
* This instance also allows to retrieve the {@link WebSocketSession} that is connected, if the application needs to
* interact with it.
*
* @author etienne-sf
*/
public interface SubscriptionClient {
/**
* Allows the client application to unsubscribe from a previously subscribed subscription. No more notification will
* be sent for this subscription.
* This will free resources on both the client and the server.
*
* @throws GraphQLRequestExecutionException
*
*/
void unsubscribe() throws GraphQLRequestExecutionException;
/**
* Allow to retrieve the {@link WebSocketSession}, when the implementation is based on Spring Reactive, which is the
* default since release 1.12
*
* @return The {@link WebSocketSession}, if the Spring reactive implementation is used. Or null otherwise
*/
WebSocketSession getSession();
}