http4k-realtime-core/org.http4k.websocket/WebsocketFactory

WebsocketFactory

Functions

abstract fun blocking(uri: Uri, headers: Headers = emptyList()): WsClient

Provides a client-side WsClient connected to a remote Websocket. This is a blocking API, so accessing the sequence of "received" messages will block on iteration until all messages are received (or the socket is closed). This call will also block while connection happens.

blocking

fun WebsocketFactory.blocking(uri: String, headers: Headers = emptyList()): WsClient

nonBlocking

abstract fun nonBlocking(uri: Uri, headers: Headers = emptyList(), onError: (Throwable) -> Unit = {}, onConnect: WsConsumer = {}): Websocket

Provides a client-side Websocket instance connected to a remote Websocket. The resultant object can be have listeners attached to it. Optionally pass a WsConsumer which will be called onConnect

nonBlocking

fun WebsocketFactory.nonBlocking(uri: String, headers: Headers = emptyList(), onError: (Throwable) -> Unit = {}, onConnect: WsConsumer = {}): Websocket