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

## Interface GraphQLWSHandler

- All Superinterfaces:
    `Handler<RoutingContext>`, `ProtocolUpgradeHandler`

      public interface GraphQLWSHandler
      extends ProtocolUpgradeHandler

  A handler for the GraphQL over WebSocket Protocol.

- - ### Method Summary

    Static Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `static GraphQLWSHandlerBuilder` | `builder​(graphql.GraphQL graphQL)` | Create a new `GraphQLWSHandlerBuilder` that will use the provided `graphQL` to build a `GraphQLWSHandler`.
    `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.

    - ### Methods inherited from interface io.vertx.core.Handler

      `handle`

- - ### Method Detail

    - #### create

          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`.

    - #### create

          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:
        `options` - options for configuring the `GraphQLWSOptions`

    - #### builder

          static GraphQLWSHandlerBuilder builder​(graphql.GraphQL graphQL)

      Create a new `GraphQLWSHandlerBuilder` that will use the provided `graphQL` to build a `GraphQLWSHandler`.