http4k-realtime-core/org.http4k.websocket

Package-level declarations

Types

abstract class PushPullAdaptingWebSocket : Websocket

Represents a connected Websocket instance, and can be passed around an application. This is configured to react to events on the WS event stream by attaching listeners.

WebsocketFactory

interface WebsocketFactory

WsClient

interface WsClient

WsConsumer

typealias WsConsumer = (Websocket) -> Unit

WsFilter

fun interface WsFilter : Function1<WsHandler, WsHandler>

WsHandler

typealias WsHandler = (Request) -> WsResponse

WsMessage

data class WsMessage(val body: Body, val mode: WsMessage.Mode)

WsResponse

data class WsResponse(val subprotocol: String? = null, val consumer: WsConsumer) : Function1<Websocket, Unit>

WsStatus

data class WsStatus(val code: Int, val description: String)

Properties

NoOp

val WsFilter.Companion.NoOp: WsFilter

Functions

blocking

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

nonBlocking

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

then

fun WsFilter.then(next: WsHandler): WsHandler

fun WsFilter.then(routingWsHandler: RoutingWsHandler): RoutingWsHandler

fun WsFilter.then(next: WsFilter): WsFilter