vertx / io.vertx.reactivex.core.http / HttpClient / websocket

websocket

open fun websocket(options: RequestOptions, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket with the specified options

Parameters

options - the request options

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(port: Int, host: String, requestURI: String, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket to the specified port, host and relative request URI

Parameters

port - the port

host - the host

requestURI - the relative URI

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(options: RequestOptions, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket with the specified options

Parameters

options - the request options

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(port: Int, host: String, requestURI: String, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket to the specified port, host and relative request URI

Parameters

port - the port

host - the host

requestURI - the relative URI

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(host: String, requestURI: String, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket to the host and relative request URI and default port

Parameters

host - the host

requestURI - the relative URI

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(host: String, requestURI: String, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket to the host and relative request URI and default port

Parameters

host - the host

requestURI - the relative URI

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(options: RequestOptions, headers: MultiMap, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket with the specified options, and with the specified headers

Parameters

options - the request options

headers - the headers

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(port: Int, host: String, requestURI: String, headers: MultiMap, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers

Parameters

port - the port

host - the host

requestURI - the relative URI

headers - the headers

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(options: RequestOptions, headers: MultiMap, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket with the specified options, and with the specified headers

Parameters

options - the request options

headers - the headers

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(port: Int, host: String, requestURI: String, headers: MultiMap, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers

Parameters

port - the port

host - the host

requestURI - the relative URI

headers - the headers

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(host: String, requestURI: String, headers: MultiMap, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers

Parameters

host - the host

requestURI - the relative URI

headers - the headers

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(host: String, requestURI: String, headers: MultiMap, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers

Parameters

host - the host

requestURI - the relative URI

headers - the headers

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(options: RequestOptions, headers: MultiMap, version: WebsocketVersion, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket with the specified optionsI, with the specified headers and using the specified version of WebSockets

Parameters

options - the request options

headers - the headers

version - the websocket version

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(port: Int, host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using the specified version of WebSockets

Parameters

port - the port

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(options: RequestOptions, headers: MultiMap, version: WebsocketVersion, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket with the specified options, with the specified headers and using the specified version of WebSockets

Parameters

options - the request options

headers - the headers

version - the websocket version

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(port: Int, host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using the specified version of WebSockets

Parameters

port - the port

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket to the specified host, relative request URI and default port with the specified headers and using the specified version of WebSockets

Parameters

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket to the specified host, relative request URI and default port with the specified headers and using the specified version of WebSockets

Parameters

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(options: RequestOptions, headers: MultiMap, version: WebsocketVersion, subProtocols: String, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket with the specified options, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols

Parameters

options - the request options

headers - the headers

version - the websocket version

subProtocols - the subprotocols to use

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(port: Int, host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion, subProtocols: String, wsConnect: Handler<WebSocket>): HttpClient

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

Parameters

port - the port

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

subProtocols - the subprotocols to use

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(options: RequestOptions, headers: MultiMap, version: WebsocketVersion, subProtocols: String, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket with the specified options, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols

Parameters

options - the request options

headers - the headers

version - the websocket version

subProtocols - the subprotocols to use

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(port: Int, host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion, subProtocols: String, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

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

Parameters

port - the port

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

subProtocols - the subprotocols to use

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion, subProtocols: String, wsConnect: Handler<WebSocket>): HttpClient

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

Parameters

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

subProtocols - the subprotocols to use

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion, subProtocols: String, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

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

Parameters

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

subProtocols - the subprotocols to use

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(requestURI: String, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket at the relative request URI using the default host and port

Parameters

requestURI - the relative URI

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(requestURI: String, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket at the relative request URI using the default host and port

Parameters

requestURI - the relative URI

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(requestURI: String, headers: MultiMap, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket at the relative request URI using the default host and port and the specified headers

Parameters

requestURI - the relative URI

headers - the headers

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(requestURI: String, headers: MultiMap, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket at the relative request URI using the default host and port and the specified headers

Parameters

requestURI - the relative URI

headers - the headers

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(requestURI: String, headers: MultiMap, version: WebsocketVersion, wsConnect: Handler<WebSocket>): HttpClient

Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the specified version of WebSockets

Parameters

requestURI - the relative URI

headers - the headers

version - the websocket version

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(requestURI: String, headers: MultiMap, version: WebsocketVersion, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the specified version of WebSockets

Parameters

requestURI - the relative URI

headers - the headers

version - the websocket version

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently

open fun websocket(requestURI: String, headers: MultiMap, version: WebsocketVersion, subProtocols: String, wsConnect: Handler<WebSocket>): HttpClient

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

Parameters

requestURI - the relative URI

headers - the headers

version - the websocket version

subProtocols - the subprotocols

wsConnect - handler that will be called with the websocket when connected

Return
a reference to this, so the API can be used fluently

open fun websocket(requestURI: String, headers: MultiMap, version: WebsocketVersion, subProtocols: String, wsConnect: Handler<WebSocket>, failureHandler: Handler<Throwable>): HttpClient

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

Parameters

requestURI - the relative URI

headers - the headers

version - the websocket version

subProtocols - the subprotocols

wsConnect - handler that will be called with the websocket when connected

failureHandler - handler that will be called if websocket connection fails

Return
a reference to this, so the API can be used fluently