api

http4k / org.http4k.websocket

Package org.http4k.websocket

Common code relevant to websocket implementations.

Types

Name Summary
PolyHandler class PolyHandler
A PolyHandler represents the combined routing logic of an Http handler and a Websocket handler. ws:// and http:// protocol calls are passed relevantly.
PushPullAdaptingWebSocket abstract class PushPullAdaptingWebSocket : Websocket
Websocket interface 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.
WsClient interface WsClient
WsMessage data class WsMessage
WsStatus data class WsStatus

Type Aliases

Name Summary
WsConsumer typealias WsConsumer = (Websocket) -> Unit
WsHandler typealias WsHandler = (Request) -> WsConsumer?