## Uses of Class
io.vertx.core.http.WebSocketConnectOptions

- Packages that use WebSocketConnectOptions
  Package | Description
  --- | ---
  io.vertx.core.http |
  io.vertx.reactivex.core.http |
  io.vertx.rxjava.core.http |
  io.vertx.rxjava3.core.http |

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

    Methods in io.vertx.core.http that return WebSocketConnectOptions
    Modifier and Type | Method and Description
    --- | ---
    `WebSocketConnectOptions` | WebSocketConnectOptions.`addHeader(CharSequence key, CharSequence value)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`addHeader(CharSequence key, Iterable<CharSequence> values)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`addHeader(String key, String value)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`addSubProtocol(String subprotocol)` Add a WebSocket sub protocol to use.
    `WebSocketConnectOptions` | WebSocketConnectOptions.`putHeader(CharSequence key, CharSequence value)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`putHeader(CharSequence key, Iterable<CharSequence> values)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`putHeader(String key, String value)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setAbsoluteURI(String absoluteURI)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setAbsoluteURI(URL url)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setAllowOriginHeader(boolean allowOriginHeader)` Set whether to add the `origin` header to the WebSocket handshake request, enabled by default.
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setConnectTimeout(long timeout)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setFollowRedirects(Boolean followRedirects)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setHeaders(MultiMap headers)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setHost(String host)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setIdleTimeout(long timeout)` Sets the amount of time after which if the WebSocket handshake does not happen within the timeout period an `WebSocketHandshakeException` will be passed to the exception handler and the connection will be closed.
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setMethod(HttpMethod method)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setPort(Integer port)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setRegisterWriteHandlers(boolean registerWriteHandlers)` Whether write-handlers should be registered on the `EventBus`.
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setServer(SocketAddress server)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setSsl(Boolean ssl)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setSubProtocols(List<String> subProtocols)` Set the WebSocket sub protocols to use.
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setTimeout(long timeout)` Sets the amount of time after which if the WebSocket handshake does not happen within the timeout period an `WebSocketHandshakeException` will be passed to the exception handler and the connection will be closed.
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setTraceOperation(String op)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setURI(String uri)`
    `WebSocketConnectOptions` | WebSocketConnectOptions.`setVersion(WebsocketVersion version)` Set the WebSocket version.

    Methods in io.vertx.core.http with parameters of type WebSocketConnectOptions
    Modifier and Type | Method and Description
    --- | ---
    `Future<WebSocket>` | ClientWebSocket.`connect(WebSocketConnectOptions options)` Like `ClientWebSocket.connect(WebSocketConnectOptions, Handler)` but returns a `Future` of the asynchronous result
    `Future<WebSocket>` | WebSocketClient.`connect(WebSocketConnectOptions options)` Like `WebSocketClient.connect(WebSocketConnectOptions, Handler)` but returns a `Future` of the asynchronous result
    `void` | ClientWebSocket.`connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)` Connect a WebSocket with the specified options.
    `void` | WebSocketClient.`connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)` Connect a WebSocket with the specified options.
    `Future<WebSocket>` | HttpClient.`webSocket(WebSocketConnectOptions options)` Deprecated. instead use `WebSocketClient.connect(WebSocketConnectOptions)`
    `void` | HttpClient.`webSocket(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)` Deprecated. instead use `WebSocketClient.connect(WebSocketConnectOptions, Handler)`

    Constructors in io.vertx.core.http with parameters of type WebSocketConnectOptions
    Constructor and Description
    `WebSocketConnectOptions(WebSocketConnectOptions other)`

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

    Methods in io.vertx.reactivex.core.http with parameters of type WebSocketConnectOptions
    Modifier and Type | Method and Description
    --- | ---
    `void` | ClientWebSocket.`connect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `void` | WebSocketClient.`connect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `void` | ClientWebSocket.`connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)` Connect a WebSocket with the specified options.
    `void` | WebSocketClient.`connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)` Connect a WebSocket with the specified options.
    `Single<WebSocket>` | ClientWebSocket.`rxConnect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `Single<WebSocket>` | WebSocketClient.`rxConnect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `Single<WebSocket>` | HttpClient.`rxWebSocket(WebSocketConnectOptions options)` Deprecated.
    `void` | HttpClient.`webSocket(WebSocketConnectOptions options)` Deprecated.
    `void` | HttpClient.`webSocket(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)` Deprecated.

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

    Methods in io.vertx.rxjava.core.http with parameters of type WebSocketConnectOptions
    Modifier and Type | Method and Description
    --- | ---
    `void` | ClientWebSocket.`connect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `void` | WebSocketClient.`connect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `void` | ClientWebSocket.`connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)` Connect a WebSocket with the specified options.
    `void` | WebSocketClient.`connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)` Connect a WebSocket with the specified options.
    `Single<WebSocket>` | ClientWebSocket.`rxConnect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `Single<WebSocket>` | WebSocketClient.`rxConnect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `Single<WebSocket>` | HttpClient.`rxWebSocket(WebSocketConnectOptions options)` Deprecated.
    `void` | HttpClient.`webSocket(WebSocketConnectOptions options)` Deprecated.
    `void` | HttpClient.`webSocket(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)` Deprecated.

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

    Methods in io.vertx.rxjava3.core.http with parameters of type WebSocketConnectOptions
    Modifier and Type | Method and Description
    --- | ---
    `Single<WebSocket>` | ClientWebSocket.`connect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `Single<WebSocket>` | WebSocketClient.`connect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `Single<WebSocket>` | ClientWebSocket.`rxConnect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `Single<WebSocket>` | WebSocketClient.`rxConnect(WebSocketConnectOptions options)` Connect a WebSocket with the specified options.
    `Single<WebSocket>` | HttpClient.`rxWebSocket(WebSocketConnectOptions options)` Deprecated.
    `Single<WebSocket>` | HttpClient.`webSocket(WebSocketConnectOptions options)` Deprecated.

Copyright © 2025 Eclipse. All rights reserved.