http4k-realtime-core/org.http4k.routing

Package-level declarations

Types

class RoutingSseHandler(routes: List<RouteMatcher<SseResponse, SseFilter>>) : RoutingHandler<SseResponse, SseFilter, RoutingSseHandler>

RoutingWsHandler

class RoutingWsHandler(routes: List<RouteMatcher<WsResponse, WsFilter>>) : RoutingHandler<WsResponse, WsFilter, RoutingWsHandler>

SimpleSseRouteMatcher

data class SimpleSseRouteMatcher(router: Router, handler: SseHandler, filter: SseFilter = SseFilter.NoOp) : RouteMatcher<SseResponse, SseFilter>

SimpleWsRouteMatcher

data class SimpleWsRouteMatcher(router: Router, handler: WsHandler, filter: WsFilter = WsFilter.NoOp) : RouteMatcher<WsResponse, WsFilter>

SseResponseWithContext

data class SseResponseWithContext(val delegate: SseResponse, val context: Map<String, Any> = emptyMap()) : SseResponse, RoutedMessage

TemplatedSseRoute

class TemplatedSseRoute(uriTemplate: UriTemplate, handler: SseHandler, router: Router = All, filter: SseFilter = SseFilter.NoOp) : TemplatedRoute<SseResponse, SseFilter, TemplatedSseRoute>

TemplatedWsRoute

class TemplatedWsRoute(uriTemplate: UriTemplate, handler: WsHandler, router: Router = All, filter: WsFilter = WsFilter.NoOp) : TemplatedRoute<WsResponse, WsFilter, TemplatedWsRoute>

WsResponseWithContext

class WsResponseWithContext(val delegate: WsResponse, val context: Map<String, Any> = emptyMap()) : WsResponse, RoutedMessage

Functions

bind

infix fun String.bind(poly: PolyHandler): List<RoutingHandler<out Any, out (Nothing) -> (Nothing) -> Any?, *>>

bindHttp

infix fun String.bindHttp(action: HttpHandler): RoutingHttpHandler

infix fun String.bindHttp(method: Method): PathMethod

infix fun String.bindHttp(action: RoutingHttpHandler): RoutingHttpHandler

bindSse

infix fun String.bindSse(action: SseHandler): RoutingSseHandler

infix fun String.bindSse(method: Method): PathMethod

infix fun String.bindSse(action: RoutingSseHandler): RoutingSseHandler

infix fun Router.bindSse(handler: SseHandler): RoutingSseHandler

infix fun Router.bindSse(handler: RoutingSseHandler): RoutingSseHandler

bindWs

infix fun String.bindWs(action: WsHandler): RoutingWsHandler

infix fun String.bindWs(action: RoutingWsHandler): RoutingWsHandler

infix fun Router.bindWs(handler: WsHandler): RoutingWsHandler

infix fun Router.bindWs(handler: RoutingWsHandler): RoutingWsHandler

poly

fun poly(vararg routes: List<RoutingHandler<*, *, *>>): PolyHandler

fun poly(vararg routes: RoutingHandler<*, *, *>): PolyHandler

sse

fun sse(sse: SseConsumer): SseHandler

fun sse(routers: List<RoutingSseHandler>): RoutingSseHandler

fun sse(vararg methods: Pair<Method, SseHandler>): SseHandler

fun sse(vararg list: RoutingSseHandler): RoutingSseHandler

thenPoly

fun Filter.thenPoly(next: HttpHandler): (request: Request) -> Response

fun SseFilter.thenPoly(next: SseHandler): (Request) -> SseResponse

fun WsFilter.thenPoly(next: WsHandler): (Request) -> WsResponse

Detect the type of a Handler and apply the filter to it. Use this in the construction of PolyFilters

infix fun PathMethod.to(handler: SseHandler): RoutingSseHandler

infix fun PathMethod.to(handler: WsHandler): RoutingWsHandler

websockets

fun websockets(ws: WsConsumer): WsHandler

fun websockets(routers: List<RoutingWsHandler>): RoutingWsHandler

fun websockets(vararg list: RoutingWsHandler): RoutingWsHandler