http4k-realtime-core/org.http4k.filter

Package-level declarations

Types

PolyFilters

object PolyFilters

Filters that work with PolyHandler (multiple protocols)

SseTransactionLabeler

typealias SseTransactionLabeler = (SseTransaction) -> SseTransaction

WsTransactionLabeler

typealias WsTransactionLabeler = (WsTransaction) -> WsTransaction

Functions

CatchAllSse

fun ServerFilters.CatchAllSse(onError: (Throwable) -> SseResponse = ::originalSseBehaviour): SseFilter

CatchAllWs

fun ServerFilters.CatchAllWs(onError: (Throwable) -> WsResponse = ::originalWsBehaviour): WsFilter

CorsAndRebindProtection

fun PolyFilters.CorsAndRebindProtection(corsPolicy: CorsPolicy): PolyFilter

Provides combination CORs and rebind protection for HTTP, SSE and WebSocket requests

fun ServerFilters.~~CorsAndRebindProtection~~(corsPolicy: CorsPolicy): PolyFilter

debug

fun SseHandler.debug(out: PrintStream = System.out, debugStream: Boolean = false): SseHandler

fun WsHandler.debug(out: PrintStream = System.out, debugStream: Boolean = false): WsHandler

fun PolyHandler.debug(out: PrintStream = System.out, debugStream: Boolean = false): PolyHandler

fun RoutingSseHandler.debug(out: PrintStream = System.out, debugStream: Boolean = false): RoutingSseHandler

fun RoutingWsHandler.debug(out: PrintStream = System.out, debugStream: Boolean = false): RoutingWsHandler

HttpRebindProtection

fun ServerFilters.HttpRebindProtection(corsPolicy: CorsPolicy): Filter

Provides CORs plus blocking rebind protection for HTTP requests.

InitialiseSseRequestContext

fun ServerFilters.~~InitialiseSseRequestContext~~(contexts: Store<RequestContext>): SseFilter

InitialiseWsRequestContext

fun ServerFilters.~~InitialiseWsRequestContext~~(contexts: Store<RequestContext>): WsFilter

originalSseBehaviour

fun originalSseBehaviour(e: Throwable): SseResponse

PrintSseRequest

fun DebuggingFilters.PrintSseRequest(out: PrintStream = System.out, debugStream: Boolean = false): SseFilter

PrintSseRequestAndResponse

fun DebuggingFilters.PrintSseRequestAndResponse(out: PrintStream = System.out, debugStream: Boolean = false): SseFilter

PrintSseResponse

fun DebuggingFilters.PrintSseResponse(out: PrintStream = System.out, shouldReport: (SseMessage) -> Boolean = { true }): SseFilter

PrintWsRequest

fun DebuggingFilters.PrintWsRequest(out: PrintStream = System.out, debugStream: Boolean = false): WsFilter

PrintWsRequestAndResponse

fun DebuggingFilters.PrintWsRequestAndResponse(out: PrintStream = System.out, debugStream: Boolean = false): WsFilter

PrintWsResponse

fun DebuggingFilters.PrintWsResponse(out: PrintStream = System.out, debugStream: Boolean = false, shouldReport: (WsMessage) -> Boolean = { true }): WsFilter

ReportSseTransaction

fun ResponseFilters.ReportSseTransaction(clock: Clock = Clock.systemUTC(), transactionLabeler: SseTransactionLabeler = { it }, recordFn: (SseTransaction) -> Unit): SseFilter

General reporting Filter for an ReportHttpTransaction. Pass an optional HttpTransactionLabeler to create custom labels. This is useful for logging metrics. Note that the passed function blocks the response from completing.

fun ResponseFilters.ReportSseTransaction(timeSource: () -> Instant, transactionLabeler: SseTransactionLabeler = { it }, recordFn: (SseTransaction) -> Unit): SseFilter

General reporting SseFilter for an ReportSseTransaction. Pass an optional SseTransactionLabeler to create custom labels. This is useful for logging metrics. Note that the passed function blocks the response from completing.

ReportWsTransaction

fun ResponseFilters.ReportWsTransaction(clock: Clock = Clock.systemUTC(), transactionLabeler: WsTransactionLabeler = { it }, recordFn: (WsTransaction) -> Unit): WsFilter

fun ResponseFilters.ReportWsTransaction(timeSource: () -> Instant, transactionLabeler: WsTransactionLabeler = { it }, recordFn: (WsTransaction) -> Unit): WsFilter

General reporting WsFilter for an ReportWsTransaction. Pass an optional WsTransactionLabeler to create custom labels. This is useful for logging metrics. Note that the passed function blocks the response from completing.

SetWsSubProtocol

fun ServerFilters.SetWsSubProtocol(subprotocol: String): WsFilter

SseRebindProtection

fun ServerFilters.SseRebindProtection(corsPolicy: CorsPolicy): SseFilter

Provides combination CORs and rebind protection for SSE requests

WsRebindProtection

fun ServerFilters.WsRebindProtection(corsPolicy: CorsPolicy): WsFilter

Provides rebind protection for WebSocket upgrade requests.