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 : AutoCloseable

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

interface WsResponse : Function1<Websocket, Unit>

WsStatus

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

Properties

NoOp

val WsFilter.Companion.NoOp: WsFilter

Functions

blocking

fun WebsocketFactory.blocking(uri: String, headers: <Error class: unknown class> = emptyList()): WsClient

nonBlocking

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

Tap

fun WsFilter.Companion.Tap(fn: (Request) -> Unit): WsFilter

then

fun WsFilter.then(next: WsHandler): WsHandler

fun WsFilter.then(routingWsHandler: RoutingWsHandler): RoutingWsHandler

fun WsFilter.then(next: WsFilter): WsFilter

toWsClient

fun Websocket.toWsClient(): WsClient

WsFilter

fun WsFilter(security: Security): WsFilter