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 theoriginal
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<GraphQLWSHandler>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description GraphQLWSHandler(GraphQLWSHandler delegate)
GraphQLWSHandler(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GraphQLWSHandler
beforeExecute(Handler<ExecutionInputBuilderWithContext<Message>> config)
Deprecated.static GraphQLWSHandlerBuilder
builder(graphql.GraphQL graphQL)
Create a newGraphQLWSHandlerBuilder
that will use the providedgraphQL
to build aGraphQLWSHandler
.GraphQLWSHandler
connectionInitHandler(Handler<ConnectionInitEvent> connectionInitHandler)
Deprecated.static GraphQLWSHandler
create(graphql.GraphQL graphQL)
Create a newGraphQLWSHandler
that will use the providedgraphQL
object to execute requests.static GraphQLWSHandler
create(graphql.GraphQL graphQL, GraphQLWSOptions options)
Create a newGraphQLWSHandler
that will use the providedgraphQL
object to execute requests.GraphQLWSHandler
endHandler(Handler<ServerWebSocket> endHandler)
Deprecated.boolean
equals(Object o)
GraphQLWSHandler
getDelegate()
void
handle(RoutingContext event)
Something has happened, so handle it.int
hashCode()
GraphQLWSHandler
messageHandler(Handler<Message> messageHandler)
Deprecated.static GraphQLWSHandler
newInstance(GraphQLWSHandler arg)
String
toString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<GraphQLWSHandler> __TYPE_ARG
-
-
Constructor Detail
-
GraphQLWSHandler
public GraphQLWSHandler(GraphQLWSHandler delegate)
-
GraphQLWSHandler
public GraphQLWSHandler(Object delegate)
-
-
Method Detail
-
getDelegate
public GraphQLWSHandler getDelegate()
- Specified by:
getDelegate
in interfaceProtocolUpgradeHandler
-
handle
public void handle(RoutingContext event)
Something has happened, so handle it.- Specified by:
handle
in interfaceHandler<RoutingContext>
- Specified by:
handle
in interfaceProtocolUpgradeHandler
- Parameters:
event
- the event to handle
-
connectionInitHandler
@Deprecated public GraphQLWSHandler connectionInitHandler(Handler<ConnectionInitEvent> connectionInitHandler)
Deprecated.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
@Deprecated public GraphQLWSHandler beforeExecute(Handler<ExecutionInputBuilderWithContext<Message>> config)
Deprecated.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
@Deprecated public GraphQLWSHandler messageHandler(Handler<Message> messageHandler)
Deprecated.Customize the message . This handler will be called for eachMessage
received.- Parameters:
messageHandler
-- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
@Deprecated public GraphQLWSHandler endHandler(Handler<ServerWebSocket> endHandler)
Deprecated.Customize the end . This handler will be called at the end of each websocket connection.- Parameters:
endHandler
-- Returns:
- a reference to this, so the API can be used fluently
-
builder
public static GraphQLWSHandlerBuilder builder(graphql.GraphQL graphQL)
Create a newGraphQLWSHandlerBuilder
that will use the providedgraphQL
to build aGraphQLWSHandler
.- Parameters:
graphQL
-- Returns:
-
create
public static GraphQLWSHandler create(graphql.GraphQL graphQL)
Create a newGraphQLWSHandler
that will use the providedgraphQL
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 newGraphQLWSHandler
that will use the providedgraphQL
object to execute requests.The handler will be configured with the given
options
.- Parameters:
graphQL
-options
- options for configuring theGraphQLWSOptions
- Returns:
-
newInstance
public static GraphQLWSHandler newInstance(GraphQLWSHandler arg)
-
-