## Uses of Interface
io.vertx.core.http.ServerWebSocket

- Packages that use ServerWebSocket
  Package | Description
  --- | ---
  io.vertx.core.http |
  io.vertx.core.spi.metrics |
  io.vertx.ext.stomp |
  io.vertx.ext.web.handler.graphql |
  io.vertx.ext.web.handler.graphql.ws |
  io.vertx.reactivex.core.http |
  io.vertx.rxjava.core.http |
  io.vertx.rxjava3.core.http |

- - ### Uses of ServerWebSocket in io.vertx.core.http

    Methods in io.vertx.core.http that return ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `ServerWebSocket` | ServerWebSocket.`closeHandler(Handler<Void> handler)`
    `ServerWebSocket` | ServerWebSocket.`drainHandler(Handler<Void> handler)`
    `ServerWebSocket` | ServerWebSocket.`endHandler(Handler<Void> endHandler)`
    `ServerWebSocket` | ServerWebSocket.`exceptionHandler(Handler<Throwable> handler)`
    `ServerWebSocket` | ServerWebSocket.`fetch(long amount)`
    `ServerWebSocket` | ServerWebSocket.`frameHandler(Handler<WebSocketFrame> handler)`
    `ServerWebSocket` | ServerWebSocket.`handler(Handler<Buffer> handler)`
    `ServerWebSocket` | ServerWebSocket.`pause()`
    `ServerWebSocket` | ServerWebSocket.`resume()`
    `ServerWebSocket` | ServerWebSocket.`setWriteQueueMaxSize(int maxSize)`
    `ServerWebSocket` | ServerWebSocket.`writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)`
    `ServerWebSocket` | ServerWebSocket.`writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)`
    `ServerWebSocket` | ServerWebSocket.`writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)`
    `ServerWebSocket` | ServerWebSocket.`writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)`
    `ServerWebSocket` | ServerWebSocket.`writePing(Buffer data, Handler<AsyncResult<Void>> handler)`
    `ServerWebSocket` | ServerWebSocket.`writePong(Buffer data, Handler<AsyncResult<Void>> handler)`
    `ServerWebSocket` | ServerWebSocket.`writeTextMessage(String text, Handler<AsyncResult<Void>> handler)`

    Methods in io.vertx.core.http that return types with arguments of type ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `Future<ServerWebSocket>` | HttpServerRequest.`toWebSocket()` Like `HttpServerRequest.toWebSocket(Handler)` but returns a `Future` of the asynchronous result
    `Handler<ServerWebSocket>` | HttpServer.`webSocketHandler()`
    `ReadStream<ServerWebSocket>` | HttpServer.`webSocketStream()` Deprecated. instead use `HttpServer.webSocketHandler(Handler)`

    Method parameters in io.vertx.core.http with type arguments of type ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `default void` | HttpServerRequest.`toWebSocket(Handler<AsyncResult<ServerWebSocket>> handler)` Upgrade the connection of the current request to a WebSocket.
    `HttpServer` | HttpServer.`webSocketHandler(Handler<ServerWebSocket> handler)` Set the WebSocket handler for the server to `wsHandler`.

  - ### Uses of ServerWebSocket in io.vertx.core.spi.metrics

    Methods in io.vertx.core.spi.metrics with parameters of type ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `default W` | HttpServerMetrics.`connected(S socketMetric, R requestMetric, ServerWebSocket serverWebSocket)` Called when a server web socket connects.

  - ### Uses of ServerWebSocket in io.vertx.ext.stomp

    Methods in io.vertx.ext.stomp that return types with arguments of type ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `Handler<ServerWebSocket>` | StompServer.`webSocketHandler()` Gets the `Handler` able to manage web socket connections.

  - ### Uses of ServerWebSocket in io.vertx.ext.web.handler.graphql

    Methods in io.vertx.ext.web.handler.graphql that return ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `ServerWebSocket` | ApolloWSMessage.`serverWebSocket()` Deprecated.

    Method parameters in io.vertx.ext.web.handler.graphql with type arguments of type ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `ApolloWSHandler` | ApolloWSHandler.`connectionHandler(Handler<ServerWebSocket> connectionHandler)` Deprecated. Customize the connection `Handler`.
    `ApolloWSHandler` | ApolloWSHandler.`endHandler(Handler<ServerWebSocket> endHandler)` Deprecated. Customize the end `Handler`.

  - ### Uses of ServerWebSocket in io.vertx.ext.web.handler.graphql.ws

    Methods in io.vertx.ext.web.handler.graphql.ws that return ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `ServerWebSocket` | Message.`socket()`

    Method parameters in io.vertx.ext.web.handler.graphql.ws with type arguments of type ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `GraphQLWSHandler` | GraphQLWSHandler.`endHandler(Handler<ServerWebSocket> endHandler)` Deprecated. as of 4.5.1, use `GraphQLWSHandler.builder(GraphQL)` instead
    `GraphQLWSHandlerBuilder` | GraphQLWSHandlerBuilder.`onSocketEnd(Handler<ServerWebSocket> endHandler)` Customize the end `Handler`.

  - ### Uses of ServerWebSocket in io.vertx.reactivex.core.http

    Methods in io.vertx.reactivex.core.http that return ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `ServerWebSocket` | ServerWebSocket.`getDelegate()`

    Methods in io.vertx.reactivex.core.http with parameters of type ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `static ServerWebSocket` | ServerWebSocket.`newInstance(ServerWebSocket arg)`

    Constructors in io.vertx.reactivex.core.http with parameters of type ServerWebSocket
    Constructor and Description
    `ServerWebSocket(ServerWebSocket delegate)`

  - ### Uses of ServerWebSocket in io.vertx.rxjava.core.http

    Methods in io.vertx.rxjava.core.http that return ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `ServerWebSocket` | ServerWebSocket.`getDelegate()`

    Methods in io.vertx.rxjava.core.http with parameters of type ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `static ServerWebSocket` | ServerWebSocket.`newInstance(ServerWebSocket arg)`

    Constructors in io.vertx.rxjava.core.http with parameters of type ServerWebSocket
    Constructor and Description
    `ServerWebSocket(ServerWebSocket delegate)`

  - ### Uses of ServerWebSocket in io.vertx.rxjava3.core.http

    Methods in io.vertx.rxjava3.core.http that return ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `ServerWebSocket` | ServerWebSocket.`getDelegate()`

    Methods in io.vertx.rxjava3.core.http with parameters of type ServerWebSocket
    Modifier and Type | Method and Description
    --- | ---
    `static ServerWebSocket` | ServerWebSocket.`newInstance(ServerWebSocket arg)`

    Constructors in io.vertx.rxjava3.core.http with parameters of type ServerWebSocket
    Constructor and Description
    `ServerWebSocket(ServerWebSocket delegate)`

Copyright © 2024 Eclipse. All rights reserved.