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

- Packages that use WebSocket
  Package | Description
  --- | ---
  io.vertx.core.http |
  io.vertx.core.spi.metrics |
  io.vertx.rxjava.core.http |

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

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

    Methods in io.vertx.core.http that return types with arguments of type WebSocket
    Modifier and Type | Method and Description
    --- | ---
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(int port, String host, String requestURI)` Create a WebSocket stream to the specified port, host and relative request URI
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(int port, String host, String requestURI, MultiMap headers)` Create a WebSocket stream to the specified port, host and relative request URI, and with the specified headers
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version)` Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers and using the specified version of WebSockets
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols)` Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(RequestOptions options)` Create a WebSocket stream with the specified options
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(RequestOptions options, MultiMap headers)` Create a WebSocket stream with the specified options, and with the specified headers
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(RequestOptions options, MultiMap headers, WebsocketVersion version)` Create a WebSocket stream with the specified options, with the specified headers and using the specified version of WebSockets
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(RequestOptions options, MultiMap headers, WebsocketVersion version, String subProtocols)` Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String requestURI)` Create a WebSocket stream at the relative request URI using the default host and port and the specified headers
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String requestURI, MultiMap headers)` Create a WebSocket stream at the relative request URI using the default host and port and the specified headers
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String requestURI, MultiMap headers, WebsocketVersion version)` Create a WebSocket stream at the relative request URI using the default host and port, the specified headers and the specified version of WebSockets
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols)` Create a WebSocket stream at the relative request URI using the default host and port, the specified headers, the specified version of WebSockets and the specified sub protocols
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String host, String requestURI)` Create a WebSocket stream to the specified host, relative request URI and default port
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String host, String requestURI, MultiMap headers)` Create a WebSocket stream to the specified host, relative request URI and default port and with the specified headers
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String host, String requestURI, MultiMap headers, WebsocketVersion version)` Create a WebSocket stream with the specified options and with the specified headers and using the specified version of WebSockets
    `ReadStream<WebSocket>` | HttpClient.`websocketStream(String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols)` Create a WebSocket stream to the specified host, relative request URI and default port, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols

    Method parameters in io.vertx.core.http with type arguments of type WebSocket
    Modifier and Type | Method and Description
    --- | ---
    `HttpClient` | HttpClient.`websocket(int port, String host, String requestURI, Handler<WebSocket> wsConnect)` Connect a WebSocket to the specified port, host and relative request URI
    `HttpClient` | HttpClient.`websocket(int port, String host, String requestURI, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket to the specified port, host and relative request URI
    `HttpClient` | HttpClient.`websocket(int port, String host, String requestURI, MultiMap headers, Handler<WebSocket> wsConnect)` Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers
    `HttpClient` | HttpClient.`websocket(int port, String host, String requestURI, MultiMap headers, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers
    `HttpClient` | HttpClient.`websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect)` Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using the specified version of WebSockets
    `HttpClient` | HttpClient.`websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using the specified version of WebSockets
    `HttpClient` | HttpClient.`websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect)` Connect a WebSocket to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
    `HttpClient` | HttpClient.`websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
    `HttpClient` | HttpClient.`websocket(RequestOptions options, Handler<WebSocket> wsConnect)` Connect a WebSocket with the specified options
    `HttpClient` | HttpClient.`websocket(RequestOptions options, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket with the specified options
    `HttpClient` | HttpClient.`websocket(RequestOptions options, MultiMap headers, Handler<WebSocket> wsConnect)` Connect a WebSocket with the specified options, and with the specified headers
    `HttpClient` | HttpClient.`websocket(RequestOptions options, MultiMap headers, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket with the specified options, and with the specified headers
    `HttpClient` | HttpClient.`websocket(RequestOptions options, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect)` Connect a WebSocket with the specified optionsI, with the specified headers and using the specified version of WebSockets
    `HttpClient` | HttpClient.`websocket(RequestOptions options, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket with the specified options, with the specified headers and using the specified version of WebSockets
    `HttpClient` | HttpClient.`websocket(RequestOptions options, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect)` Connect a WebSocket with the specified options, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
    `HttpClient` | HttpClient.`websocket(RequestOptions options, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket with the specified options, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
    `HttpClient` | HttpClient.`websocket(String requestURI, Handler<WebSocket> wsConnect)` Connect a WebSocket at the relative request URI using the default host and port
    `HttpClient` | HttpClient.`websocket(String requestURI, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket at the relative request URI using the default host and port
    `HttpClient` | HttpClient.`websocket(String requestURI, MultiMap headers, Handler<WebSocket> wsConnect)` Connect a WebSocket at the relative request URI using the default host and port and the specified headers
    `HttpClient` | HttpClient.`websocket(String requestURI, MultiMap headers, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket at the relative request URI using the default host and port and the specified headers
    `HttpClient` | HttpClient.`websocket(String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect)` Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the specified version of WebSockets
    `HttpClient` | HttpClient.`websocket(String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the specified version of WebSockets
    `HttpClient` | HttpClient.`websocket(String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect)` Connect a WebSocket at the relative request URI using the default host and port, the specified headers, the specified version of WebSockets and the specified sub protocols
    `HttpClient` | HttpClient.`websocket(String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket at the relative request URI using the default host and port, the specified headers, the specified version of WebSockets and the specified sub protocols
    `HttpClient` | HttpClient.`websocket(String host, String requestURI, Handler<WebSocket> wsConnect)` Connect a WebSocket to the host and relative request URI and default port
    `HttpClient` | HttpClient.`websocket(String host, String requestURI, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket to the host and relative request URI and default port
    `HttpClient` | HttpClient.`websocket(String host, String requestURI, MultiMap headers, Handler<WebSocket> wsConnect)` Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers
    `HttpClient` | HttpClient.`websocket(String host, String requestURI, MultiMap headers, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers
    `HttpClient` | HttpClient.`websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect)` Connect a WebSocket to the specified host, relative request URI and default port with the specified headers and using the specified version of WebSockets
    `HttpClient` | HttpClient.`websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket to the specified host, relative request URI and default port with the specified headers and using the specified version of WebSockets
    `HttpClient` | HttpClient.`websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect)` Connect a WebSocket to the specified host, relative request URI and default port, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
    `HttpClient` | HttpClient.`websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler)` Connect a WebSocket to the specified host, relative request URI and default port, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols

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

    Methods in io.vertx.core.spi.metrics with parameters of type WebSocket
    Modifier and Type | Method and Description
    --- | ---
    `W` | HttpClientMetrics.`connected(E endpointMetric, S socketMetric, WebSocket webSocket)` Called when a web socket connects.

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

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

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

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

Copyright © 2017. All rights reserved.