io.vertx.reactivex.ext.web.handler.graphql.ws

Class GraphQLWSHandler

java.lang.Object

io.vertx.reactivex.ext.web.handler.graphql.ws.GraphQLWSHandler

All Implemented Interfaces:

Handler<RoutingContext>, ProtocolUpgradeHandler

public class GraphQLWSHandler
extends Object
implements ProtocolUpgradeHandler, Handler<RoutingContext>

A handler for the GraphQL over WebSocket Protocol.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.rx.TypeArg<GraphQLWSHandler>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
GraphQLWSHandler(GraphQLWSHandler delegate)
GraphQLWSHandler(Object delegate)

Method Summary

Modifier and Type	Method and Description
GraphQLWSHandler	beforeExecute(Handler<ExecutionInputBuilderWithContext<Message>> config) Set a callback to invoke before executing a GraphQL query.
GraphQLWSHandler	connectionInitHandler(Handler<ConnectionInitEvent> connectionInitHandler) Customize the connection init .
static GraphQLWSHandler	create(graphql.GraphQL graphQL) Create a new GraphQLWSHandler that will use the provided graphQL object to execute requests.
static GraphQLWSHandler	create(graphql.GraphQL graphQL, GraphQLWSOptions options) Create a new GraphQLWSHandler that will use the provided graphQL object to execute requests.
boolean	equals(Object o)
GraphQLWSHandler	getDelegate()
void	handle(RoutingContext event) Something has happened, so handle it.
int	hashCode()
GraphQLWSHandler	messageHandler(Handler<Message> messageHandler) Customize the message .
static GraphQLWSHandler	newInstance(GraphQLWSHandler arg)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vertx.reactivex.ext.web.handler.ProtocolUpgradeHandler

newInstance

Field Detail

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<GraphQLWSHandler> __TYPE_ARG

Constructor Detail

GraphQLWSHandler

public GraphQLWSHandler(GraphQLWSHandler delegate)

GraphQLWSHandler

public GraphQLWSHandler(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public GraphQLWSHandler getDelegate()

Specified by:

getDelegate in interface ProtocolUpgradeHandler

handle

public void handle(RoutingContext event)

Something has happened, so handle it.

Specified by:

handle in interface Handler<RoutingContext>

Specified by:

handle in interface ProtocolUpgradeHandler

Parameters:

event - the event to handle

connectionInitHandler

public GraphQLWSHandler connectionInitHandler(Handler<ConnectionInitEvent> connectionInitHandler)

Customize the connection init . This handler will be called when the message is received.

Parameters:

connectionInitHandler -

Returns:

a reference to this, so the API can be used fluently

beforeExecute

public GraphQLWSHandler beforeExecute(Handler<ExecutionInputBuilderWithContext<Message>> config)

Set a callback to invoke before executing a GraphQL query.

Parameters:

config - the callback to invoke

Returns:

a reference to this, so the API can be used fluently

messageHandler

public GraphQLWSHandler messageHandler(Handler<Message> messageHandler)

Customize the message . This handler will be called for each Message received.

Parameters:

messageHandler -

Returns:

a reference to this, so the API can be used fluently

create

public static GraphQLWSHandler create(graphql.GraphQL graphQL)

Create a new GraphQLWSHandler that will use the provided graphQL object to execute requests.

The handler will be configured with the default GraphQLWSOptions.

Parameters:

graphQL -

Returns:

create

public static GraphQLWSHandler create(graphql.GraphQL graphQL,
                                      GraphQLWSOptions options)

Create a new GraphQLWSHandler that will use the provided graphQL object to execute requests.

The handler will be configured with the given options.

Parameters:

graphQL -

options - options for configuring the GraphQLWSOptions

Returns:

newInstance

public static GraphQLWSHandler newInstance(GraphQLWSHandler arg)