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

## Class GraphQLWSHandler

- java.lang.Object
- - io.vertx.rxjava3.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

    All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `GraphQLWSHandler` | `beforeExecute(Handler<ExecutionInputBuilderWithContext<Message>> config)` Deprecated.
    `static GraphQLWSHandlerBuilder` | `builder(graphql.GraphQL graphQL)` Create a new `GraphQLWSHandlerBuilder` that will use the provided `graphQL` to build a `GraphQLWSHandler`.
    `GraphQLWSHandler` | `connectionInitHandler(Handler<ConnectionInitEvent> connectionInitHandler)` Deprecated.
    `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.
    `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()`

    - ### Methods inherited from class java.lang.Object

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

    - ### Methods inherited from interface io.vertx.rxjava3.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

          @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 each `Message` 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 new `GraphQLWSHandlerBuilder` that will use the provided `graphQL` to build a `GraphQLWSHandler`.
      Parameters:
        `graphQL` -
      Returns:

    - #### 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)

Copyright © 2024 Eclipse. All rights reserved.