vertx / io.vertx.kotlin.core.http / webSocketConnectOptionsOf

# webSocketConnectOptionsOf

`fun webSocketConnectOptionsOf(absoluteURI: String? = null, followRedirects: Boolean? = null, headers: Map<String, String>? = null, host: String? = null, method: HttpMethod? = null, port: Int? = null, server: SocketAddress? = null, ssl: Boolean? = null, subProtocols: Iterable<String>? = null, timeout: Long? = null, uri: String? = null, version: WebsocketVersion? = null): WebSocketConnectOptions`

A function providing a DSL for building io.vertx.core.http.WebSocketConnectOptions objects.

Options describing how an io.vertx.core.http.HttpClient connect a io.vertx.core.http.WebSocket.

### Parameters

`absoluteURI` - Parse an absolute URI to use, this will update the ssl, host, port and uri fields.

`followRedirects` - Set whether to follow HTTP redirect

`headers` - Add a request header.

`host` - Set the host name to be used by the client request.

`method` - Set the HTTP method to be used by the client request.

`port` - Set the port to be used by the client request.

`server` - Set the server address to be used by the client request. When the server address is null, the address will be resolved after the host property by the Vert.x resolver. Use this when you want to connect to a specific server address without name resolution.

`ssl` - Set whether SSL/TLS is enabled.

`subProtocols` - Set the WebSocket sub protocols to use.

`timeout` - Sets the amount of time after which if the request does not return any data within the timeout period an java.util.concurrent.TimeoutException will be passed to the exception handler and the request will be closed.

`uri` - Set the request relative URI.

`version` - Set the WebSocket version.