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

websocketStream

open fun websocketStream(options: RequestOptions): ReadStream<WebSocket>

Create a WebSocket stream with the specified options

Parameters

options - the request options

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(port: Int, host: String, requestURI: String): ReadStream<WebSocket>

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

Parameters

port - the port

host - the host

requestURI - the relative URI

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(host: String, requestURI: String): ReadStream<WebSocket>

Create a WebSocket stream to the specified host, relative request URI and default port

Parameters

host - the host

requestURI - the relative URI

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(options: RequestOptions, headers: MultiMap): ReadStream<WebSocket>

Create a WebSocket stream with the specified options, and with the specified headers

Parameters

options - the request options

headers - the headers

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(port: Int, host: String, requestURI: String, headers: MultiMap): ReadStream<WebSocket>

Create a WebSocket stream 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

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(host: String, requestURI: String, headers: MultiMap): ReadStream<WebSocket>

Create a WebSocket stream to the specified host, relative request URI and default port and with the specified headers

Parameters

host - the host

requestURI - the relative URI

headers - the headers

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(options: RequestOptions, headers: MultiMap, version: WebsocketVersion): ReadStream<WebSocket>

Create a WebSocket stream 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

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(port: Int, host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion): ReadStream<WebSocket>

Create a WebSocket stream 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

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion): ReadStream<WebSocket>

Create a WebSocket stream with the specified options and 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

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(options: RequestOptions, headers: MultiMap, version: WebsocketVersion, subProtocols: String): ReadStream<WebSocket>

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

Parameters

options - the request options

headers - the headers

version - the websocket version

subProtocols - the subprotocols to use

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(port: Int, host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion, subProtocols: String): ReadStream<WebSocket>

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

Parameters

port - the port

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

subProtocols - the subprotocols to use

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(host: String, requestURI: String, headers: MultiMap, version: WebsocketVersion, subProtocols: String): ReadStream<WebSocket>

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

Parameters

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

subProtocols - the subprotocols to use

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(requestURI: String): ReadStream<WebSocket>

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

Parameters

requestURI - the relative URI

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(requestURI: String, headers: MultiMap): ReadStream<WebSocket>

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

Parameters

requestURI - the relative URI

headers - the headers

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(requestURI: String, headers: MultiMap, version: WebsocketVersion): ReadStream<WebSocket>

Create a WebSocket stream 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

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket

open fun websocketStream(requestURI: String, headers: MultiMap, version: WebsocketVersion, subProtocols: String): ReadStream<WebSocket>

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

Parameters

requestURI - the relative URI

headers - the headers

version - the websocket version

subProtocols - the subprotocols

Return
a stream emitting a WebSocket event when the client connection has been upgraded to a websocket